netgate-host-acl API (23.02)

This YANG module provides a data model for host ACL data.

host-config

returns netgate.host.acl.HostConfig

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

Example URL

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

Host configuration parameters.

Responses

200

netgate.host.acl.HostConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-acl: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-acl:host-config-wrapper":
{
- "netgate-host-acl:host-config":
  {
  - "security":
    {
    "host-acls":
    {
    "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code": 0
    },
    "destination-port":
    {
    "last": 0,
    "first": 0
    }
    },
    "source": "string",
    "version": 0
    }
    }
    }
    ],
    "description": "string",
    "acl-name": "string"
    }
    ]
    }
    }
  }
}

}

creates netgate.host.acl.HostConfig

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

Example URL

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

Host configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.acl.HostConfig to be added to list

netgate-host-acl:host-config

object (netgate.host.acl.HostConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-acl:host-config":
{
- "security":
  {
  - "host-acls":
    {
    "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code": 0
    },
    "destination-port":
    {
    "last": 0,
    "first": 0
    }
    },
    "source": "string",
    "version": 0
    }
    }
    }
    ],
    "description": "string",
    "acl-name": "string"
    }
    ]
    }
  }
}

}

creates or updates netgate.host.acl.HostConfig

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

Example URL

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

Host configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.acl.HostConfig to be added or updated

netgate-host-acl:host-config-wrapper

object (netgate.host.acl.HostConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-acl:host-config-wrapper":
{
- "netgate-host-acl:host-config":
  {
  - "security":
    {
    "host-acls":
    {
    "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code": 0
    },
    "destination-port":
    {
    "last": 0,
    "first": 0
    }
    },
    "source": "string",
    "version": 0
    }
    }
    }
    ],
    "description": "string",
    "acl-name": "string"
    }
    ]
    }
    }
  }
}

}

removes netgate.host.acl.HostConfig

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

Example URL

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

Host configuration parameters.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-acl: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.acl.hostconfig.Security

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

Example URL

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

Host security configuration parameters.

Responses

200

netgate.host.acl.hostconfig.Security

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-acl:host-config/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-acl:security-wrapper":
{
- "security":
  {
  - "host-acls":
    {
    "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code": 0
    },
    "destination-port":
    {
    "last": 0,
    "first": 0
    }
    },
    "source": "string",
    "version": 0
    }
    }
    }
    ],
    "description": "string",
    "acl-name": "string"
    }
    ]
    }
  }
}

}

creates netgate.host.acl.hostconfig.Security

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

Example URL

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

Host security configuration parameters.

Request Body schema: application/yang-data+json

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

security

object (netgate.host.acl.hostconfig.Security)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"security":
{
- "host-acls":
  {
  - "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code": 0
    },
    "destination-port":
    {
    "last": 0,
    "first": 0
    }
    },
    "source": "string",
    "version": 0
    }
    }
    }
    ],
    "description": "string",
    "acl-name": "string"
    }
    ]
  }
}

}

creates or updates netgate.host.acl.hostconfig.Security

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

Example URL

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

Host security configuration parameters.

Request Body schema: application/yang-data+json

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

netgate-host-acl:security-wrapper

object (netgate.host.acl.hostconfig.SecurityWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-acl:security-wrapper":
{
- "security":
  {
  - "host-acls":
    {
    "host-acl":
    [
    {
    "acl-seq": 0,
    "acl-rule":
    [
    {
    "rule-seq": 0,
    "action": "permit",
    "description": "string",
    "packet-match":
    {
    "link":
    {
    "destination": "string",
    "source": "string"
    },
    "input-if": "string",
    "ip":
    {
    "destination": "string",
    "protocol": "string",
    "transport":
    {
    "tcp":
    {
    "flags":
    {
    "rst": false,
    "psh": false,
    "ece": false,
    "ack": false,
    "syn": false,
    "fin": false,
    "urg": false,
    "cwr": false
    }
    },
    "source-port":
    {
    "last": 0,
    "first": 0
    },
    "icmp":
    {
    "icmp-type": "echo-reply",
    "icmpv6-type": "destination-unreachable",
    "code":