StaticARPConfig

Contains Static ARP configuration for Segment.

Properties

integer

_create_time Optional

Timestamp of resource creation

string

_create_user Optional

ID of the user who created this resource

integer

_last_modified_time Optional

Timestamp of last modification

string

_last_modified_user Optional

ID of the user who last modified this resource

array of ResourceLink

_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

string

_protection Optional

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.

integer

_revision Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

string

_schema Optional

Schema for this resource

SelfResourceLink

_self Optional

Link to this resource

boolean

_system_owned Optional

Indicates system owned resource

array of ChildPolicyConfigResource

children Optional

subtree for this type within policy tree containing nested elements.

string

description Optional

Description of this resource

string

display_name Optional

Defaults to ID if not set

string

id Optional

Unique identifier of this resource

string

ip_address Optional

IP Address

string

mac_address Optional

MAC Address

boolean

marked_for_delete Optional

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.

string

parent_path Optional

Path of its parent

string

path Optional

Absolute path of this object

string

relative_path Optional

Path relative from its parent

string

resource_type Optional

The type of this resource.

array of Tag

tags Optional

Opaque identifiers meaningful to the API user

Property Of

ChildStaticARPConfig

Parameter To

Create Static ARP Config
Update Static ARP Config

Returned By

Create Static ARP Config
Get Static ARP Config

Extends

PolicyConfigResource

JSON Example

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "id": "string",
    "ip_address": "string",
    "mac_address": "string",
    "marked_for_delete": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}

StaticARPConfig

Properties

Property Of

Parameter To

Returned By

Extends

JSON Example

Was this page helpful?