netscaler.adc.lsnpool_lsnip_binding (2.5.1) — module

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

Binding Resource definition for describing association between lsnpool and lsnip resources

Inputs

    
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

lsnip:
    description:
    - IPv4 address or a range of IPv4 addresses to be used as NAT IP address(es) for LSN.
    - 'After the pool is created, these IPv4 addresses are added to the Citrix ADC as
      Citrix ADC owned IP address of type LSN. A maximum of 4096 IP addresses can be bound
      to an LSN pool. An LSN IP address associated with an LSN pool cannot be shared with
      other LSN pools. IP addresses specified for this parameter must not already exist
      on the Citrix ADC as any Citrix ADC owned IP addresses. In the command line interface,
      separate the range with a hyphen. For example: 10.102.29.30-10.102.29.189. You can
      later remove some or all the LSN IP addresses from the pool, and add IP addresses
      to the LSN pool.'
    - By default , arp is enabled on LSN IP address but, you can disable it using command
      - "set ns ip"
    type: str

state:
    choices:
    - present
    - absent
    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.
    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

poolname:
    description:
    - 'Name for the LSN pool. Must begin with an ASCII alphanumeric or underscore (_)
      character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be
      changed after the LSN pool is created. The following requirement applies only to
      the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in
      double or single quotation marks (for example, "lsn pool1" or ''lsn pool1'').'
    type: str

ownernode:
    description:
    - ID(s) of cluster node(s) on which command is to be executed
    type: float

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

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

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    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

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

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