Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

arp

May 23, 2024
Contributed by: 
C

Configuration for arp resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ipaddress Read-write IP address of the network device that you want to add to the ARP table.

Minimum length = 1
td Read-write Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

Minimum value = 0

Maximum value = 4094
mac Read-write MAC address of the network device.
ifnum Read-write Interface through which the network device is accessible. Specify the interface in (slot/port) notation. For example, 1/3.
vxlan Read-write ID of the VXLAN on which the IP address of this ARP entry is reachable.

Minimum value = 1

Maximum value = 16777215
vtep Read-write IP address of the VXLAN tunnel endpoint (VTEP) through which the IP address of this ARP entry is reachable.

Minimum length = 1
vlan Read-write The VLAN ID through which packets are to be sent after matching the ARP entry. This is a numeric value.
ownernode Read-write The owner node for the Arp entry.

Minimum value = 0

Maximum value = 31
all Read-write Remove all ARP entries from the ARP table of the Citrix ADC.
nodeid Read-write Unique number that identifies the cluster node.

Minimum value = 0

Maximum value = 31
timeout Read-only The time, in seconds, after which the entry times out.
state Read-only The state of the ARP entry.
flags Read-only The flags for the entry.
type Read-only Indicates whether this ARP entry was added manually or dynamically. When you manually add an ARP entry, the value for this parameter is STATIC. Otherwise, it is DYNAMIC. For the NSIP and loopback IP addresses, the value is PERMANENT.

Possible values = STATIC, PERMANENT, DYNAMIC
channel Read-only The tunnel, channel, or physical interface through which the ARP entry is identified.
controlplane Read-only This arp entry is populated by a control plane protocol.
__count Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • SEND
  • GET (ALL)
  • COUNT

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/arp HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"arp":{
<b>"ipaddress":<String_value>,
</b>"td":<Double_value>,
<b>"mac":<String_value>,
</b>"ifnum":<String_value>,
"vxlan":<Double_value>,
"vtep":<String_value>,
"vlan":<Double_value>,
"ownernode":<Double_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/arp/ ipaddress_value<String> Query-parameters: args=td: <Double_value> ,all: <Boolean_value> ,ownernode: <Double_value>

</b>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

send

URL: http:// <netscaler-ip-address> /nitro/v1/config/arp? action=send HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"arp":{
"ipaddress":<String_value>,
"td":<Double_value>,
"all":<Boolean_value>
}}

<!--NeedCopy-->

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/arp Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/arp? args=ipaddress: <String_value> ,td: <Double_value> ,ownernode: <Double_value> ,nodeid: <Double_value>

Use this query-parameter to get arp resources based on additional properties.

attrs http:// <netscaler-ip-address> /nitro/v1/config/arp? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter http:// <netscaler-ip-address> /nitro/v1/config/arp? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of arp resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view http:// <netscaler-ip-address> /nitro/v1/config/arp? view=summary

Use this query-parameter to get the summary output of arp resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination http:// <netscaler-ip-address> /nitro/v1/config/arp? pagesize=#no;pageno=#no

Use this query-parameter to get the arp resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{ "arp": [ {
ipaddress:<String_value>,td:<Double_value>,ownernode:<Double_value>,nodeid:<Double_value>"mac":<String_value>,
"ifnum":<String_value>,
"timeout":<Double_value>,
"state":<Double_value>,
"flags":<Double_value>,
"type":<String_value>,
"vlan":<Double_value>,
"vxlan":<Double_value>,
"vtep":<String_value>,
"channel":<Double_value>,
"controlplane":<Boolean_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/arp? count=yes HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response: HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 

{ "arp": [ { "__count": "#no"} ] }

<!--NeedCopy-->
arp
May 23, 2024
Contributed by: 
C
May 23, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.