Skip to content

ns_vmacs

Configuration for vmacs for shared vlans resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
vmacs<String>Read-writeComma Seperated VMac list.
Minimum length = 1
additional_mac_free_count<Integer>Read-writePlace holder for to view additional mac count.
ns_ip_address<String>Read-writeNetScaler IP Address.
Minimum length = 1
Maximum length = 64
increment_by<Integer>Read-writeincrement by.
Minimum value = 1
Maximum value =
generation_method<String>Read-write(MANUAL, BASE or RANDOM).
Minimum length = 4
Maximum length = 16
vmac_count<Integer>Read-writeincrement by.
Minimum value = 1
sync_operation<Boolean>Read-writesync operation.
base_vmac<String>Read-writeBase VMac Address.
Minimum length = 1
Maximum length = 32
act_id<String>Read-onlyActivity Id.

Operations

(click to see Properties)

ADD| REMOVE| GET (ALL)

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: https://<MGMT-IP>/nitro/v1/config/ns_vmacs?onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_vmacs: {
<b>"ns_ip_address":<String_value></b>,
<b>"generation_method":<String_value></b>,
"increment_by":<Integer_value>,
"vmac_count":<Integer_value>,
"additional_mac_free_count":<Integer_value>,
"vmacs":<String_value>,
"base_vmac":<String_value>,
"sync_operation":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_vmacs":[{
"vmacs":<String_value>,
"additional_mac_free_count":<Integer_value>,
"ns_ip_address":<String_value>,
"increment_by":<Integer_value>,
"generation_method":<String_value>,
"vmac_count":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"base_vmac":<String_value>}]}

remove

URL: https://<MGMT-IP>/nitro/v1/config/ns_vmacs?action=remove;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_vmacs: {
"increment_by":<Integer_value>,
"vmac_count":<Integer_value>,
"additional_mac_free_count":<Integer_value>,
"ns_ip_address":<String_value>,
"generation_method":<String_value>,
"vmacs":<String_value>,
"base_vmac":<String_value>,
"sync_operation":<Boolean_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_vmacs":[{
"vmacs":<String_value>,
"additional_mac_free_count":<Integer_value>,
"ns_ip_address":<String_value>,
"increment_by":<Integer_value>,
"generation_method":<String_value>,
"vmac_count":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"base_vmac":<String_value>}]}

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_vmacs

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_vmacs":[{
"vmacs":<String_value>,
"additional_mac_free_count":<Integer_value>,
"ns_ip_address":<String_value>,
"increment_by":<Integer_value>,
"generation_method":<String_value>,
"vmac_count":<Integer_value>,
"act_id":<String_value>,
"sync_operation":<Boolean_value>,
"base_vmac":<String_value>}]}