Description
The addNetworkObjectGroup operation handles configuration related to NetworkObjectGroup model.
This API call is not allowed on the standby unit in an HA pair.
HTTP request
POST /api/fdm/v6/object/networkgroups
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
name | True | string | A string that is the name of the network group object. | |||
description | False | string | A string containing the description information Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist) |
|||
isSystemDefined | False | boolean | A Boolean value, TRUE or FALSE(the default). The TRUE value indicates that this Network object group is a system defined object | |||
objects | False | [object] | A comma-delimited list of references of NetworkObject or NetworkObjectGroup objects, or both, that are part of this group Allowed types are: [NetworkObject, NetworkObjectGroup] |
|||
type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. |
Example
curl -X POST \
--header "Accept: application/json" \
--header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"description": "string",
"id": "string",
"isSystemDefined": true,
"name": "string",
"objects": [],
"type": "networkobjectgroup",
"version": "string"
}' \
"https://${HOST}:${PORT}/api/fdm/v6/object/networkgroups"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient
def get_client(host, token):
http_client = RequestsClient()
http_client.ssl_verify = False
http_client.set_api_key(
host,
"Bearer {}".format(token),
param_name="Authorization",
param_in="header"
)
return SwaggerClient.from_url(
"https://{}/apispec/ngfw.json".format(host),
http_client=http_client,
config={
"validate_responses": False,
"validate_swagger_spec": False
}
)
def add_network_object_group(client, body):
return client.NetworkObject.addNetworkObjectGroup(
body=body
).response().result
if __name__ == "__main__":
host = "ftd.example.com"
token = "access_token"
client = get_client(host, token)
body = {'description': 'string',
'isSystemDefined': True,
'name': 'string',
'objects': [],
'type': 'networkobjectgroup'}
add_network_object_group(client, body)