netscaler.adc.clusterfiles (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 files resource.

Inputs

    
mode:
    choices:
    - all
    - bookmarks
    - ssl
    - imports
    - misc
    - dns
    - krb
    - AAA
    - app_catalog
    - all_plus_misc
    - all_minus_misc
    description:
    - 'The directories and files to be synchronized. The available settings function as
      follows:'
    - ' Mode    Paths'
    - ' C(all)           /nsconfig/C(ssl)/'
    - '                /var/netscaler/C(ssl)/'
    - '                /var/vpn/bookmark/'
    - '                /nsconfig/C(dns)/'
    - '                /nsconfig/monitors/'
    - '                /nsconfig/nstemplates/'
    - '                /nsconfig/ssh/'
    - '                /nsconfig/rc.netscaler'
    - '                /nsconfig/resolv.conf'
    - '                /nsconfig/inetd.conf'
    - '                /nsconfig/syslog.conf'
    - '                /nsconfig/ntp.conf'
    - '                /nsconfig/httpd.conf'
    - '                /nsconfig/sshd_config'
    - '                /nsconfig/hosts'
    - '                /nsconfig/enckey'
    - '                /var/nslw.bin/etc/krb5.conf'
    - '                /var/nslw.bin/etc/krb5.keytab'
    - '                /var/lib/likewise/db/'
    - '                /var/download/'
    - '                /var/wi/tomcat/webapps/'
    - '                /var/wi/tomcat/conf/Catalina/localhost/'
    - '                /var/wi/java_home/lib/security/cacerts'
    - '                /var/wi/java_home/jre/lib/security/cacerts'
    - '                /var/netscaler/locdb/'
    - C(ssl)            /nsconfig/C(ssl)/
    - '                 /var/netscaler/C(ssl)/'
    - C(bookmarks)     /var/vpn/bookmark/
    - C(dns)                  /nsconfig/C(dns)/
    - C(imports)          /var/download/
    - C(misc)               /nsconfig/license/
    - '                       /nsconfig/rc.conf'
    - C(all_plus_misc)    Includes *C(all)* files and /nsconfig/license/ and /nsconfig/rc.conf.
    - 'Default value: C(all)'
    elements: str
    type: list

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

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

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