netscaler.adc.nsip6 module – Configuration for ip6 resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.nsip6.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for ip6 resource.

Parameters

Parameter

Comments

advertiseondefaultpartition

any

Advertise VIPs from Shared VLAN on Default Partition

Choices:

  • "ENABLED"

  • "DISABLED"

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

decrementhoplimit

any

Decrement Hop Limit by 1 when ENABLED.This setting is applicable only for UDP traffic.

Choices:

  • "ENABLED"

  • "DISABLED"

dynamicrouting

any

Allow dynamic routing on this IP address. Specific to Subnet IPv6 (SNIP6) address.

Choices:

  • "ENABLED"

  • "DISABLED"

ftp

any

Allow File Transfer Protocol (FTP) access to this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

gui

any

Allow graphical user interface (GUI) access to this IP address.

Choices:

  • "ENABLED"

  • "SECUREONLY"

  • "DISABLED"

hostroute

any

Option to push the VIP6 to ZebOS routing table for Kernel route redistribution through dynamic routing protocols.

Choices:

  • "ENABLED"

  • "DISABLED"

icmp

any

Respond to ICMP requests for this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

ip6hostrtgw

any

IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as the gateway.

ipv6address

any

IPv6 address to create on the Citrix ADC.

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

map

any

Mapped IPV4 address for the IPV6 address.

metric

any

Integer value to add to or subtract from the cost of the route advertised for the VIP6 address.

mgmtaccess

any

Allow access to management applications on this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

mptcpadvertise

any

If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as part of ADD_ADDR option.

Choices:

  • "YES"

  • "NO"

nd

any

Respond to Neighbor Discovery (ND) requests for this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

ndowner

any

NdOwner in Cluster for VIPS and Striped SNIPS

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

networkroute

any

Option to push the SNIP6 subnet to ZebOS routing table for Kernel route redistribution through dynamic routing protocol.

Choices:

  • "ENABLED"

  • "DISABLED"

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

The ip address of the NetScaler ADC appliance where the nitro API calls will be made.

The port can be specified with the colon (:). E.g. 192.168.1.1:555.

ospf6lsatype

any

Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for advertising the route for the VIP6 address.

Choices:

  • "INTRA_AREA"

  • "EXTERNAL"

ospfarea

any

ID of the area in which the Intra-Area-Prefix LSAs are to be advertised for the VIP6 address by the IPv6 OSPF protocol running on the Citrix ADC. When ospfArea is not set, VIP6 is advertised on all areas.

ownerdownresponse

any

in cluster system, if the owner node is down, whether should it respond to icmp/arp

Choices:

  • "YES"

  • "NO"

ownernode

float

ID of the cluster node for which you are adding the IP address. Must be used if you want the IP address to be active only on the specific node. Can be configured only through the cluster IP address. Cannot be changed after the IP address is created.

restrictaccess

any

Block access to nonmanagement applications on this IP address. This option is applicable forMIP6s, SNIP6s, and NSIP6s, and is disabled by default. Nonmanagement applications can run on the underlying Citrix ADC Free BSD operating system.

Choices:

  • "ENABLED"

  • "DISABLED"

save_config

boolean

If true the module will save the configuration on the NetScaler ADC node if it makes any changes.

The module will not save the configuration on the NetScaler ADC node if it made no changes.

Choices:

  • false ← (default)

  • true

scope

string

Scope of the IPv6 address to be created. Cannot be changed after the IP address is created.

Choices:

  • "global"

  • "link-local"

snmp

any

Allow Simple Network Management Protocol (SNMP) access to this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

ssh

any

Allow secure Shell (SSH) access to this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "unset"

tag

any

Tag value for the network/host route associated with this IP.

td

any

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.

telnet

any

Allow Telnet access to this IP address.

Choices:

  • "ENABLED"

  • "DISABLED"

type

string

Type of IP address to be created on the Citrix ADC. Cannot be changed after the IP address is created.

Choices:

  • "NSIP"

  • "VIP"

  • "SNIP"

  • "GSLBsiteIP"

  • "ADNSsvcIP"

  • "RADIUSListenersvcIP"

  • "CLIP"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

vlan

float

The VLAN number.

vrid6

any

A positive integer that uniquely identifies a VMAC address for binding to this VIP address. This binding is used to set up Citrix ADCs in an active-active configuration using VRRP.

vserver

any

Enable or disable the state of all the virtual servers associated with this VIP6 address.

Choices:

  • "ENABLED"

  • "DISABLED"

vserverrhilevel

any

Advertise or do not advertise the route for the Virtual IP (VIP6) address on the basis of the state of the virtual servers associated with that VIP6.

* NONE - Advertise the route for the VIP6 address, irrespective of the state of the virtual servers associated with the address.

* ONE VSERVER - Advertise the route for the VIP6 address if at least one of the associated virtual servers is in UP state.

* ALL VSERVER - Advertise the route for the VIP6 address if all of the associated virtual servers are in UP state.

* VSVR_CNTRLD. Advertise the route for the VIP address according to the RHIstate (RHI STATE) parameter setting on all the associated virtual servers of the VIP address along with their states.

When Vserver RHI Level (RHI) parameter is set to VSVR_CNTRLD, the following are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE) settings on the virtual servers associated with the VIP address:

* If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always advertises the route for the VIP address.

* If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers is in UP state.

*If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC advertises the route for the VIP address if at least one of the associated virtual servers, whose RHI STATE set to ACTIVE, is in UP state.

Choices:

  • "ONE_VSERVER"

  • "ALL_VSERVERS"

  • "NONE"

  • "VSVR_CNTRLD"

Notes

Note

Examples

---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | nsip6
      delegate_to: localhost
      netscaler.adc.nsip6:
        state: present
        ipv6address: ae80::1024:45aa:fe3b:9843/64
        scope: link-local
        type: SNIP
        vlan: '1'
        vserver: DISABLED
        mgmtaccess: DISABLED
        dynamicrouting: ENABLED

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

List of differences between the actual configured object and the configuration specified in the module

Returned: when changed

Sample: ["Attribute `key1` differs. Desired: (<class 'str'>) XYZ. Existing: (<class 'str'>) PQR"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)