Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-acl API (19.02)

This YANG module provides a Netgate-defined data-model for Access Control Lists.

Copyright 2017-2019 Rubicon Communications, LLC.

acl-config

returns netgate.acl.AclConfig

get /data/netgate-acl:acl-config

Example URL

https://hostname/restconf/data/netgate-acl:acl-config

Access Control Lists (ACL) data needed to support VPP.

Responses

200

netgate.acl.AclConfig

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-config":
    {
    }
}

creates netgate.acl.AclConfig

post /data/netgate-acl:acl-config

Example URL

https://hostname/restconf/data/netgate-acl:acl-config

Access Control Lists (ACL) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.acl.AclConfig to be added to list

macip-table
object (netgate.acl.aclconfig.MacipTable)
acl-table
object (netgate.acl.aclconfig.AclTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-table":
    {
    },
  • "acl-table":
    {
    }
}

creates or updates netgate.acl.AclConfig

put /data/netgate-acl:acl-config

Example URL

https://hostname/restconf/data/netgate-acl:acl-config

Access Control Lists (ACL) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.acl.AclConfig to be added or updated

netgate-acl:acl-config
object (netgate.acl.AclConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-config":
    {
    }
}

removes netgate.acl.AclConfig

delete /data/netgate-acl:acl-config

Example URL

https://hostname/restconf/data/netgate-acl:acl-config

Access Control Lists (ACL) data needed to support VPP.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.acl.aclconfig.AclTable

get /data/netgate-acl:acl-config/netgate-acl:acl-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table

Table of ACL lists, indexed by name. Each entry contains a set of ACL Rules ordered by sequence number.

Responses

200

netgate.acl.aclconfig.AclTable

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-table":
    {
    }
}

creates netgate.acl.aclconfig.AclTable

post /data/netgate-acl:acl-config/netgate-acl:acl-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table

Table of ACL lists, indexed by name. Each entry contains a set of ACL Rules ordered by sequence number.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.AclTable to be added to list

acl-list
Array of objects (netgate.acl.aclconfig.acltable.AclList)

ACL list name.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-list":
    [
    ]
}

creates or updates netgate.acl.aclconfig.AclTable

put /data/netgate-acl:acl-config/netgate-acl:acl-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table

Table of ACL lists, indexed by name. Each entry contains a set of ACL Rules ordered by sequence number.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.AclTable to be added or updated

netgate-acl:acl-table
object (netgate.acl.aclconfig.AclTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-table":
    {
    }
}

removes netgate.acl.aclconfig.AclTable

delete /data/netgate-acl:acl-config/netgate-acl:acl-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table

Table of ACL lists, indexed by name. Each entry contains a set of ACL Rules ordered by sequence number.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.acl.aclconfig.acltable.AclList

post /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list

ACL list name.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.AclList to be added to list

acl-name
string

The ACL name as supplied by the developer. It is a unique name used to identify this set of ACL Rules.

acl-rules
object (netgate.acl.aclconfig.acltable.acllist.AclRules)
acl-description
string

A text description for the ACL.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-name": "string",
  • "acl-rules":
    {
    },
  • "acl-description": "string"
}

returns netgate.acl.aclconfig.acltable.AclList

get /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

ACL list name.

path Parameters
acl-name
required
string

Id of acl-list

Responses

200

netgate.acl.aclconfig.acltable.AclList

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-list":
    {
    }
}

creates netgate.acl.aclconfig.acltable.AclList

post /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

ACL list name.

path Parameters
acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.AclList to be added to list

acl-name
string

The ACL name as supplied by the developer. It is a unique name used to identify this set of ACL Rules.

acl-rules
object (netgate.acl.aclconfig.acltable.acllist.AclRules)
acl-description
string

A text description for the ACL.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-name": "string",
  • "acl-rules":
    {
    },
  • "acl-description": "string"
}

creates or updates netgate.acl.aclconfig.acltable.AclList

put /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

ACL list name.

path Parameters
acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.AclList to be added or updated

netgate-acl:acl-list
object (netgate.acl.aclconfig.acltable.AclList)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-list":
    {
    }
}

removes netgate.acl.aclconfig.acltable.AclList

delete /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

ACL list name.

path Parameters
acl-name
required
string

Id of acl-list

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.acl.aclconfig.acltable.acllist.AclRules

get /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

ACL Rule Table ordered by sequence number.

path Parameters
acl-name
required
string

Id of acl-list

Responses

200

netgate.acl.aclconfig.acltable.acllist.AclRules

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rules":
    {
    }
}

creates netgate.acl.aclconfig.acltable.acllist.AclRules

post /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

ACL Rule Table ordered by sequence number.

path Parameters
acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.acllist.AclRules to be added to list

acl-rule
Array of objects (netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule)

A List of ACL Rules.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-rule":
    [
    ]
}

creates or updates netgate.acl.aclconfig.acltable.acllist.AclRules

put /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

ACL Rule Table ordered by sequence number.

path Parameters
acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.acllist.AclRules to be added or updated

netgate-acl:acl-rules
object (netgate.acl.aclconfig.acltable.acllist.AclRules)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rules":
    {
    }
}

removes netgate.acl.aclconfig.acltable.acllist.AclRules

delete /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

ACL Rule Table ordered by sequence number.

path Parameters
acl-name
required
string

Id of acl-list

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

post /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule to be added to list

src-last-port
integer <int32>

The last source port in a range.

icmp-first-code
integer <int32>

The first ICMP code in a range.

icmp-last-code
integer <int32>

The last ICMP code in a range.

acl-rule-description
string

A text description for the ACL rule.

icmp-first-type
integer <int32>

The first ICMP type in a range.

tcp-flags-mask
integer <int32>

The TCP flags mask.

src-first-port
integer <int32>

The first source port in a range.

sequence
integer <int64>

Rules are executed in increasing sequence number.

protocol
string (netgate.acl.AclProtocol)
Enum: "tcp" "udp" "icmp"
dst-last-port
integer <int32>

The last destination port in a range.

dst-ip-prefix
string

The IPv4 or IPv6 destination prefix.

action
string (netgate.acl.AclRuleAction)
Enum: "deny" "permit" "reflect"
tcp-flags-value
integer <int32>

The TCP flags value.

src-ip-prefix
string

The IPv4 or IPv6 source prefix.

icmp-last-type
integer <int32>

The last ICMP type in a range.

dst-first-port
integer <int32>

The first destination port in a range.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "src-last-port": 0,
  • "icmp-first-code": 0,
  • "icmp-last-code": 0,
  • "acl-rule-description": "string",
  • "icmp-first-type": 0,
  • "tcp-flags-mask": 0,
  • "src-first-port": 0,
  • "sequence": 0,
  • "protocol": "tcp",
  • "dst-last-port": 0,
  • "dst-ip-prefix": "string",
  • "action": "deny",
  • "tcp-flags-value": 0,
  • "src-ip-prefix": "string",
  • "icmp-last-type": 0,
  • "dst-first-port": 0
}

returns netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

get /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

sequence
required
integer <int64>

Id of acl-rule

Responses

200

netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules/netgate-acl:acl-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rule":
    {
    }
}

creates netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

post /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

sequence
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule to be added to list

src-last-port
integer <int32>

The last source port in a range.

icmp-first-code
integer <int32>

The first ICMP code in a range.

icmp-last-code
integer <int32>

The last ICMP code in a range.

acl-rule-description
string

A text description for the ACL rule.

icmp-first-type
integer <int32>

The first ICMP type in a range.

tcp-flags-mask
integer <int32>

The TCP flags mask.

src-first-port
integer <int32>

The first source port in a range.

sequence
integer <int64>

Rules are executed in increasing sequence number.

protocol
string (netgate.acl.AclProtocol)
Enum: "tcp" "udp" "icmp"
dst-last-port
integer <int32>

The last destination port in a range.

dst-ip-prefix
string

The IPv4 or IPv6 destination prefix.

action
string (netgate.acl.AclRuleAction)
Enum: "deny" "permit" "reflect"
tcp-flags-value
integer <int32>

The TCP flags value.

src-ip-prefix
string

The IPv4 or IPv6 source prefix.

icmp-last-type
integer <int32>

The last ICMP type in a range.

dst-first-port
integer <int32>

The first destination port in a range.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "src-last-port": 0,
  • "icmp-first-code": 0,
  • "icmp-last-code": 0,
  • "acl-rule-description": "string",
  • "icmp-first-type": 0,
  • "tcp-flags-mask": 0,
  • "src-first-port": 0,
  • "sequence": 0,
  • "protocol": "tcp",
  • "dst-last-port": 0,
  • "dst-ip-prefix": "string",
  • "action": "deny",
  • "tcp-flags-value": 0,
  • "src-ip-prefix": "string",
  • "icmp-last-type": 0,
  • "dst-first-port": 0
}

creates or updates netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

put /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

sequence
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule to be added or updated

netgate-acl:acl-rule
object (netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rule":
    {
    }
}

removes netgate.acl.aclconfig.acltable.acllist.aclrules.AclRule

delete /data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

sequence
required
integer <int64>

Id of acl-rule

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules/netgate-acl:acl-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.acl.aclconfig.MacipTable

get /data/netgate-acl:acl-config/netgate-acl:macip-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table

Table of MACIP lists, indexed by name. Each entry contains a set of MACIP Rules ordered by sequence number.

Responses

200

netgate.acl.aclconfig.MacipTable

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-table":
    {
    }
}

creates netgate.acl.aclconfig.MacipTable

post /data/netgate-acl:acl-config/netgate-acl:macip-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table

Table of MACIP lists, indexed by name. Each entry contains a set of MACIP Rules ordered by sequence number.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.MacipTable to be added to list

macip-list
Array of objects (netgate.acl.aclconfig.maciptable.MacipList)

MACIP list name.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-list":
    [
    ]
}

creates or updates netgate.acl.aclconfig.MacipTable

put /data/netgate-acl:acl-config/netgate-acl:macip-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table

Table of MACIP lists, indexed by name. Each entry contains a set of MACIP Rules ordered by sequence number.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.MacipTable to be added or updated

netgate-acl:macip-table
object (netgate.acl.aclconfig.MacipTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-table":
    {
    }
}

removes netgate.acl.aclconfig.MacipTable

delete /data/netgate-acl:acl-config/netgate-acl:macip-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table

Table of MACIP lists, indexed by name. Each entry contains a set of MACIP Rules ordered by sequence number.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.acl.aclconfig.maciptable.MacipList

post /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list

MACIP list name.

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.MacipList to be added to list

macip-name
string

The MACIP name as supplied by the developer. It is a unique name used to identify this set of MACIP Rules.

macip-rules
object (netgate.acl.aclconfig.maciptable.maciplist.MacipRules)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-name": "string",
  • "macip-rules":
    {
    }
}

returns netgate.acl.aclconfig.maciptable.MacipList

get /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

MACIP list name.

path Parameters
macip-name
required
string

Id of macip-list

Responses

200

netgate.acl.aclconfig.maciptable.MacipList

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-list":
    {
    }
}

creates netgate.acl.aclconfig.maciptable.MacipList

post /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

MACIP list name.

path Parameters
macip-name
required
string

Id of macip-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.MacipList to be added to list

macip-name
string

The MACIP name as supplied by the developer. It is a unique name used to identify this set of MACIP Rules.

macip-rules
object (netgate.acl.aclconfig.maciptable.maciplist.MacipRules)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-name": "string",
  • "macip-rules":
    {
    }
}

creates or updates netgate.acl.aclconfig.maciptable.MacipList

put /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

MACIP list name.

path Parameters
macip-name
required
string

Id of macip-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.MacipList to be added or updated

netgate-acl:macip-list
object (netgate.acl.aclconfig.maciptable.MacipList)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-list":
    {
    }
}

removes netgate.acl.aclconfig.maciptable.MacipList

delete /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

MACIP list name.

path Parameters
macip-name
required
string

Id of macip-list

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.acl.aclconfig.maciptable.maciplist.MacipRules

get /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

MACIP Rule Table ordered by sequence number.

path Parameters
macip-name
required
string

Id of macip-list

Responses

200

netgate.acl.aclconfig.maciptable.maciplist.MacipRules

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rules":
    {
    }
}

creates netgate.acl.aclconfig.maciptable.maciplist.MacipRules

post /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

MACIP Rule Table ordered by sequence number.

path Parameters
macip-name
required
string

Id of macip-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.maciplist.MacipRules to be added to list

macip-rule
Array of objects (netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule)

A List of MACIP Rules.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-rule":
    [
    ]
}

creates or updates netgate.acl.aclconfig.maciptable.maciplist.MacipRules

put /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

MACIP Rule Table ordered by sequence number.

path Parameters
macip-name
required
string

Id of macip-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.maciplist.MacipRules to be added or updated

netgate-acl:macip-rules
object (netgate.acl.aclconfig.maciptable.maciplist.MacipRules)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rules":
    {
    }
}

removes netgate.acl.aclconfig.maciptable.maciplist.MacipRules

delete /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

MACIP Rule Table ordered by sequence number.

path Parameters
macip-name
required
string

Id of macip-list

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

post /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule to be added to list

mac-address
string

The L2 MAC address to be matched.

sequence
integer <int64>

Rules are executed in increasing sequence number.

action
string (netgate.acl.MacipRuleAction)
Enum: "deny" "permit"
ip-prefix
string

The IPv4 or IPv6 source prefix.

mac-mask
string

The L2 MAC mask ANDed with packet MAC addresses.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "sequence": 0,
  • "action": "deny",
  • "ip-prefix": "string",
  • "mac-mask": "string"
}

returns netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

get /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

sequence
required
integer <int64>

Id of macip-rule

Responses

200

netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules/netgate-acl:macip-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rule":
    {
    }
}

creates netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

post /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

sequence
required
integer <int64>

Id of macip-rule

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule to be added to list

mac-address
string

The L2 MAC address to be matched.

sequence
integer <int64>

Rules are executed in increasing sequence number.

action
string (netgate.acl.MacipRuleAction)
Enum: "deny" "permit"
ip-prefix
string

The IPv4 or IPv6 source prefix.

mac-mask
string

The L2 MAC mask ANDed with packet MAC addresses.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "sequence": 0,
  • "action": "deny",
  • "ip-prefix": "string",
  • "mac-mask": "string"
}

creates or updates netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

put /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

sequence
required
integer <int64>

Id of macip-rule

Request Body schema: application/yang-data+json

netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule to be added or updated

netgate-acl:macip-rule
object (netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rule":
    {
    }
}

removes netgate.acl.aclconfig.maciptable.maciplist.maciprules.MacipRule

delete /data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

sequence
required
integer <int64>

Id of macip-rule

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-config/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules/netgate-acl:macip-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

acl-state

returns netgate.acl.AclState

get /data/netgate-acl:acl-state

Example URL

https://hostname/restconf/data/netgate-acl:acl-state

Access Control Lists (ACL) state data.

Responses

200

netgate.acl.AclState

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-state":
    {
    }
}

returns netgate.acl.aclstate.AclTable

get /data/netgate-acl:acl-state/netgate-acl:acl-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table

Table of ACL lists, indexed by name. Each entry contains a set of ACL Rules ordered by sequence number.

Responses

200

netgate.acl.aclstate.AclTable

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-table":
    {
    }
}

returns netgate.acl.aclstate.acltable.AclList

get /data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}

ACL list name.

path Parameters
acl-name
required
string

Id of acl-list

Responses

200

netgate.acl.aclstate.acltable.AclList

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-list":
    {
    }
}

returns netgate.acl.aclstate.acltable.acllist.AclRules

get /data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules

ACL Rule Table ordered by sequence number.

path Parameters
acl-name
required
string

Id of acl-list

Responses

200

netgate.acl.aclstate.acltable.acllist.AclRules

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rules":
    {
    }
}

returns netgate.acl.aclstate.acltable.acllist.aclrules.AclRule

get /data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list={acl-name}/netgate-acl:acl-rules/netgate-acl:acl-rule={sequence}

A List of ACL Rules.

path Parameters
acl-name
required
string

Id of acl-list

sequence
required
integer <int64>

Id of acl-rule

Responses

200

netgate.acl.aclstate.acltable.acllist.aclrules.AclRule

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:acl-table/netgate-acl:acl-list=%7Bacl-name%7D/netgate-acl:acl-rules/netgate-acl:acl-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:acl-rule":
    {
    }
}

returns netgate.acl.aclstate.MacipTable

get /data/netgate-acl:acl-state/netgate-acl:macip-table

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table

Table of MACIP lists, indexed by name. Each entry contains a set of MACIP Rules ordered by sequence number.

Responses

200

netgate.acl.aclstate.MacipTable

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-table":
    {
    }
}

returns netgate.acl.aclstate.maciptable.MacipList

get /data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}

MACIP list name.

path Parameters
macip-name
required
string

Id of macip-list

Responses

200

netgate.acl.aclstate.maciptable.MacipList

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-list":
    {
    }
}

returns netgate.acl.aclstate.maciptable.maciplist.MacipRules

get /data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules

MACIP Rule Table ordered by sequence number.

path Parameters
macip-name
required
string

Id of macip-list

Responses

200

netgate.acl.aclstate.maciptable.maciplist.MacipRules

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rules":
    {
    }
}

returns netgate.acl.aclstate.maciptable.maciplist.maciprules.MacipRule

get /data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

Example URL

https://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list={macip-name}/netgate-acl:macip-rules/netgate-acl:macip-rule={sequence}

A List of MACIP Rules.

path Parameters
macip-name
required
string

Id of macip-list

sequence
required
integer <int64>

Id of macip-rule

Responses

200

netgate.acl.aclstate.maciptable.maciplist.maciprules.MacipRule

400

Internal error

Request samples

Copy
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-acl:acl-state/netgate-acl:macip-table/netgate-acl:macip-list=%7Bmacip-name%7D/netgate-acl:macip-rules/netgate-acl:macip-rule=%7Bsequence%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-acl:macip-rule":
    {
    }
}