netscaler.adc.nsip6 (2.5.1) — module

Configuration for ip6 resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1


Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for ip6 resource.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- 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

Inputs

    
nd:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Respond to Neighbor Discovery (ND) requests for this IP address.
    type: str

td:
    description:
    - 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.
    type: float

ftp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow File Transfer Protocol (FTP) access to this IP address.
    type: str

gui:
    choices:
    - ENABLED
    - SECUREONLY
    - DISABLED
    description:
    - Allow graphical user interface (GUI) access to this IP address.
    type: str

map:
    description:
    - Mapped IPV4 address for the IPV6 address.
    type: str

ssh:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow secure Shell (SSH) access to this IP address.
    type: str

tag:
    description:
    - Tag value for the network/host route associated with this IP.
    type: float

icmp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Respond to ICMP requests for this IP address.
    type: str

nsip:
    description:
    - 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.
    required: true
    type: str

snmp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow Simple Network Management Protocol (SNMP) access to this IP address.
    type: str

type:
    choices:
    - NSIP
    - VIP
    - SNIP
    - GSLBsiteIP
    - ADNSsvcIP
    - RADIUSListenersvcIP
    - CLIP
    description:
    - Type of IP address to be created on the Citrix ADC. Cannot be changed after the
      IP address is created.
    type: str

vlan:
    description:
    - The VLAN number.
    type: float

scope:
    choices:
    - global
    - link-local
    description:
    - Scope of the IPv6 address to be created. Cannot be changed after the IP address
      is created.
    type: str

state:
    choices:
    - present
    - absent
    - unset
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(present), the resource will be added/updated configured according to the
      module's parameters.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

vrid6:
    description:
    - 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.
    type: float

metric:
    description:
    - Integer value to add to or subtract from the cost of the route advertised for the
      VIP6 address.
    type: int

telnet:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow Telnet access to this IP address.
    type: str

ndowner:
    description:
    - NdOwner in Cluster for VIPS and Striped SNIPS
    type: float

vserver:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Enable or disable the state of all the virtual servers associated with this VIP6
      address.
    type: str

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

ospfarea:
    description:
    - 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.
    type: float

hostroute:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Option to push the VIP6 to ZebOS routing table for Kernel route redistribution through
      dynamic routing protocols.
    type: str

ownernode:
    description:
    - 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.
    type: float

mgmtaccess:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow access to management applications on this IP address.
    type: str

nitro_pass:
    description:
    - The password with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the NetScaler ADC node.
    required: false
    type: str

ip6hostrtgw:
    description:
    - 'IPv6 address of the gateway for the route. If Gateway is not set, VIP uses :: as
      the gateway.'
    type: str

ipv6address:
    description:
    - IPv6 address to create on the Citrix ADC.
    type: str

save_config:
    default: false
    description:
    - If C(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.
    type: bool

networkroute:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Option to push the SNIP6 subnet to ZebOS routing table for Kernel route redistribution
      through dynamic routing protocol.
    type: str

ospf6lsatype:
    choices:
    - INTRA_AREA
    - EXTERNAL
    description:
    - Type of LSAs to be used by the IPv6 OSPF protocol, running on the Citrix ADC, for
      advertising the route for the VIP6 address.
    type: str

dynamicrouting:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Allow dynamic routing on this IP address. Specific to Subnet IPv6 (SNIP6) address.
    type: str

mptcpadvertise:
    choices:
    - 'YES'
    - 'NO'
    description:
    - If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as
      part of ADD_ADDR option.
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

restrictaccess:
    choices:
    - ENABLED
    - DISABLED
    description:
    - 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.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), SSL certificates will not be validated. This should only be used on
      personally controlled sites using self-signed certificates.
    required: false
    type: bool

vserverrhilevel:
    choices:
    - ONE_VSERVER
    - ALL_VSERVERS
    - NONE
    - VSVR_CNTRLD
    description:
    - 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.
    - '* C(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.'
    - '* C(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 C(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.'
    type: str

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

decrementhoplimit:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Decrement Hop Limit by 1 when C(ENABLED).This setting is applicable only for UDP
      traffic.
    type: str

ownerdownresponse:
    choices:
    - 'YES'
    - 'NO'
    description:
    - in cluster system, if the owner node is down, whether should it respond to icmp/arp
    type: str

advertiseondefaultpartition:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Advertise VIPs from Shared VLAN on Default Partition
    type: str

Outputs

changed:
  description: Indicates if any change is made by the module
  returned: always
  sample: true
  type: bool
diff:
  description: Dictionary of before and after changes
  returned: always
  sample:
    after:
      key2: pqr
    before:
      key1: xyz
    prepared: changes done
  type: dict
diff_list:
  description: 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'
  type: list
failed:
  description: Indicates if the module failed or not
  returned: always
  sample: false
  type: bool
loglines:
  description: list of logged messages by the module
  returned: always
  sample:
  - message 1
  - message 2
  type: list