netscaler.adc.install (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

Configuration for 0 resource.

Inputs

    
a:
    description:
    - Use this flag to enable Citrix ADM Service Connect. This feature helps you discover
      your Citrix ADC instances effortlessly on Citrix ADM service and get insights and
      curated machine learning based recommendations for applications and Citrix ADC infrastructure.
      This feature lets the Citrix ADC instance automatically send system, usage and telemetry
      data to Citrix ADM service. View here [https://docs.citrix.com/en-us/citrix-adc/13/data-governance.html]
      to learn more about this feature. Use of this feature is subject to the Citrix End
      User ServiceAgreement. View here [https://www.citrix.com/buy/licensing/agreements.html].
    type: bool

l:
    description:
    - Use this flag to enable callhome.
    type: bool

y:
    description:
    - Do not prompt for yes/no before rebooting.
    type: bool

url:
    description:
    - 'Url for the build file. Must be in the following formats:'
    - http://[user]:[password]@host/path/to/file
    - https://[user]:[password]@host/path/to/file
    - sftp://[user]:[password]@host/path/to/file
    - scp://[user]:[password]@host/path/to/file
    - ftp://[user]:[password]@host/path/to/file
    - file://path/to/file
    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

async:
    description:
    - Use this flag to return the install id when the nitro api request is sent.
    - The id can be used later to track the installation progress via show ns job <id>
      command.
    - For the cli request of install the flag is by default set as false as the installation
      progress details can be tracked via cli
    type: bool

state:
    choices: []
    default: present
    description:
    - The state of the resource being configured by the module on 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

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

resizeswapvar:
    description:
    - Use this flag to change swap size on ONLY 64bit nCore/MCNS/VMPE systems NON-VPX
      systems.
    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

enhancedupgrade:
    description:
    - Use this flag for upgrading from/to enhancement mode.
    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