Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-host API (19.02)

This YANG module provides a data model for host data.

Copyright 2019 Rubicon Communications, LLC.

host-config

returns netgate.host.HostConfig

get /data/netgate-host:host-config

Example URL

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

Host configuration parameters.

Responses

200

netgate.host.HostConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-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-host:host-config":
    {
    }
}

creates netgate.host.HostConfig

post /data/netgate-host:host-config

Example URL

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

Host configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.HostConfig to be added to list

security
object (netgate.host.hostconfig.Security)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.host.HostConfig

put /data/netgate-host:host-config

Example URL

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

Host configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.HostConfig to be added or updated

netgate-host:host-config
object (netgate.host.HostConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.HostConfig

delete /data/netgate-host:host-config

Example URL

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

Host configuration parameters.

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-host:host-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.host.hostconfig.Security

get /data/netgate-host:host-config/netgate-host:security

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security

Host security configuration parameters.

Responses

200

netgate.host.hostconfig.Security

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-host:security":
    {
    }
}

creates netgate.host.hostconfig.Security

post /data/netgate-host:host-config/netgate-host:security

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security

Host security configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.hostconfig.Security to be added to list

host-acls
object (netgate.host.hostconfig.security.HostAcls)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "host-acls":
    {
    }
}

creates or updates netgate.host.hostconfig.Security

put /data/netgate-host:host-config/netgate-host:security

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security

Host security configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.hostconfig.Security to be added or updated

netgate-host:security
object (netgate.host.hostconfig.Security)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.Security

delete /data/netgate-host:host-config/netgate-host:security

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security

Host security configuration parameters.

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-host:host-config/netgate-host:security"

	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.host.hostconfig.security.HostAcls

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Host access lists (ACLs).

Responses

200

netgate.host.hostconfig.security.HostAcls

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls"

	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-host:host-acls":
    {
    }
}

creates netgate.host.hostconfig.security.HostAcls

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Host access lists (ACLs).

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.HostAcls to be added to list

host-acl
Array of objects (netgate.host.hostconfig.security.hostacls.HostAcl)

The list of configured host ACLs.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.host.hostconfig.security.HostAcls

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Host access lists (ACLs).

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.HostAcls to be added or updated

netgate-host:host-acls
object (netgate.host.hostconfig.security.HostAcls)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.HostAcls

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls

Host access lists (ACLs).

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-host:host-config/netgate-host:security/netgate-host:host-acls"

	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.host.hostconfig.security.hostacls.HostAcl

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl

The list of configured host ACLs.

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.HostAcl to be added to list

acl-seq
integer <int64>

The sequence number of the host ACL.

acl-rule
Array of objects (netgate.host.hostconfig.security.hostacls.hostacl.AclRule)

The list of the host ACL rules.

description
string

The description of the host ACL.

acl-name
string

The name of the host 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-seq": 0,
  • "acl-rule":
    [
    ],
  • "description": "string",
  • "acl-name": "string"
}

returns netgate.host.hostconfig.security.hostacls.HostAcl

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

The list of configured host ACLs.

path Parameters
acl-name
required
string

Id of host-acl

Responses

200

netgate.host.hostconfig.security.hostacls.HostAcl

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%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-host:host-acl":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.HostAcl

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

The list of configured host ACLs.

path Parameters
acl-name
required
string

Id of host-acl

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.HostAcl to be added to list

acl-seq
integer <int64>

The sequence number of the host ACL.

acl-rule
Array of objects (netgate.host.hostconfig.security.hostacls.hostacl.AclRule)

The list of the host ACL rules.

description
string

The description of the host ACL.

acl-name
string

The name of the host 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-seq": 0,
  • "acl-rule":
    [
    ],
  • "description": "string",
  • "acl-name": "string"
}

creates or updates netgate.host.hostconfig.security.hostacls.HostAcl

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

The list of configured host ACLs.

path Parameters
acl-name
required
string

Id of host-acl

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.HostAcl to be added or updated

netgate-host:host-acl
object (netgate.host.hostconfig.security.hostacls.HostAcl)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.HostAcl

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}

The list of configured host ACLs.

path Parameters
acl-name
required
string

Id of host-acl

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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%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))

}

creates netgate.host.hostconfig.security.hostacls.hostacl.AclRule

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule

The list of the host ACL rules.

path Parameters
acl-name
required
string

Id of host-acl

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.AclRule to be added to list

rule-seq
integer <int64>

The sequence number of the rule.

action
string (netgate.host.HostAclAction)
Enum: "permit" "deny"
description
string

The description of the rule.

packet-match
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "rule-seq": 0,
  • "action": "permit",
  • "description": "string",
  • "packet-match":
    {
    }
}

returns netgate.host.hostconfig.security.hostacls.hostacl.AclRule

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

The list of the host ACL rules.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.AclRule

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%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-host:acl-rule":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.AclRule

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

The list of the host ACL rules.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.AclRule to be added to list

rule-seq
integer <int64>

The sequence number of the rule.

action
string (netgate.host.HostAclAction)
Enum: "permit" "deny"
description
string

The description of the rule.

packet-match
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "rule-seq": 0,
  • "action": "permit",
  • "description": "string",
  • "packet-match":
    {
    }
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.AclRule

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

The list of the host ACL rules.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.AclRule to be added or updated

netgate-host:acl-rule
object (netgate.host.hostconfig.security.hostacls.hostacl.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-host:acl-rule":
    {
    }
}

removes netgate.host.hostconfig.security.hostacls.hostacl.AclRule

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}

The list of the host ACL rules.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%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.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

The matching packets of the rule.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match"

	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-host:packet-match":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

The matching packets of the rule.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch to be added to list

link
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link)
input-if
string

The input interface name.

ip
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "link":
    {
    },
  • "input-if": "string",
  • "ip":
    {
    }
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

The matching packets of the rule.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch to be added or updated

netgate-host:packet-match
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-host:packet-match":
    {
    }
}

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.PacketMatch

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match

The matching packets of the rule.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

IP traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip"

	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-host:ip":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

IP traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip to be added to list

destination
string

The destination IP prefix.

protocol
string (netgate.host.HostAclProtocol)
Enum: "icmp" "tcp" "udp"
transport
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport)
source
string

The source IP prefix.

version
integer <int32>

IP version.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "destination": "string",
  • "protocol": "icmp",
  • "transport":
    {
    },
  • "source": "string",
  • "version": 0
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

IP traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip to be added or updated

netgate-host:ip
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Ip

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip

IP traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Transport options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport"

	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-host:transport":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Transport options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport to be added to list

tcp
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp)
source-port
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort)
icmp
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp)
destination-port
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "tcp":
    {
    },
  • "source-port":
    {
    },
  • "icmp":
    {
    },
  • "destination-port":
    {
    }
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Transport options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport to be added or updated

netgate-host:transport
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.Transport

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport

Transport options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

The destination port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port"

	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-host:destination-port":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

The destination port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort to be added to list

last
integer <int32>

The last port number.

first
integer <int32>

The first port number.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "last": 0,
  • "first": 0
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

The destination port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort to be added or updated

netgate-host:destination-port
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-host:destination-port":
    {
    }
}

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.DestinationPort

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port

The destination port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:destination-port"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

ICMP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp"

	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-host:icmp":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

ICMP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp to be added to list

type
string (netgate.host.HostAclIcmpType)
Enum: "echo-reply" "destination-unreachable" "source-quench" "redirect" "echo-request" "time-exceeded" "parameter-problem" "timestamp-request" "timestamp-reply" "info-request" "info-reply" "address-mask-request" "address-mask-reply" "router-advertisement" "router-solicitation"
code
integer <int32>

ICMP code.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "type": "echo-reply",
  • "code": 0
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

ICMP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp to be added or updated

netgate-host:icmp
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Icmp

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp

ICMP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:icmp"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

The source port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port"

	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-host:source-port":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

The source port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort to be added to list

last
integer <int32>

The last port number.

first
integer <int32>

The first port number.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "last": 0,
  • "first": 0
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

The source port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort to be added or updated

netgate-host:source-port
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-host:source-port":
    {
    }
}

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.SourcePort

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port

The source port range.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:source-port"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

TCP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp"

	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-host:tcp":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

TCP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp to be added to list

flags
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

TCP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp to be added or updated

netgate-host:tcp
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.Tcp

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp

TCP options.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

TCP flags.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags"

	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-host:flags":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

TCP flags.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags to be added to list

rst
boolean

Reset.

psh
boolean

Push.

ns
boolean

Nonce Sum.

ece
boolean

ECN-Echo.

ack
boolean

Acknowledgment.

syn
boolean

Synchronize.

fin
boolean

Finished.

urg
boolean

Urgent.

cwr
boolean

Congestion Window Reduced.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "rst": true,
  • "psh": true,
  • "ns": true,
  • "ece": true,
  • "ack": true,
  • "syn": true,
  • "fin": true,
  • "urg": true,
  • "cwr": true
}

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

TCP flags.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags to be added or updated

netgate-host:flags
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.ip.transport.tcp.Flags

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags

TCP flags.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:ip/netgate-host:transport/netgate-host:tcp/netgate-host:flags"

	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.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link

get /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Ethernet traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Responses

200

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:link"

	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-host:link":
    {
    }
}

creates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link

post /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Ethernet traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link to be added to list

destination
string

The destination MAC address.

source
string

The source MAC address.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link

put /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Ethernet traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
required
integer <int64>

Id of acl-rule

Request Body schema: application/yang-data+json

netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link to be added or updated

netgate-host:link
object (netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.host.hostconfig.security.hostacls.hostacl.aclrule.packetmatch.Link

delete /data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Example URL

https://hostname/restconf/data/netgate-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl={acl-name}/netgate-host:acl-rule={rule-seq}/netgate-host:packet-match/netgate-host:link

Ethernet traffic match.

path Parameters
acl-name
required
string

Id of host-acl

rule-seq
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-host:host-config/netgate-host:security/netgate-host:host-acls/netgate-host:host-acl=%7Bacl-name%7D/netgate-host:acl-rule=%7Brule-seq%7D/netgate-host:packet-match/netgate-host:link"

	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))

}