netscaler.adc.logout (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 logging out from a NetScaler ADC node.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

---
- name: Sample login  and logout playbook
  hosts: demo_netscalers

  gather_facts: false

  tasks:
    - name: V2 | Sample Task | login
      delegate_to: localhost
      register: login_result
      netscaler.adc.login:
        # nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
        # nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
        # validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
        # save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable

        username: nsroot
        password: verysecretpassword

    - name: Print login sessionid
      ansible.builtin.debug:
        var: login_result.sessionid

    - name: V2 | Sample Task | nsip
      delegate_to: localhost
      netscaler.adc.nsip:
        # `nitro_auth_token` can also be given via NETSCALER_NITRO_AUTH_TOKEN environment variable
        nitro_auth_token: "{{ login_result.sessionid }}"
        # nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
        # nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
        # validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
        # save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable

        state: present

        ipaddress: 4.4.4.4
        netmask: 255.255.255.192
        type: VIP

    - name: V2 | Sample Task | logout
      delegate_to: localhost
      netscaler.adc.logout:
        # `nitro_auth_token` can also be given via NETSCALER_NITRO_AUTH_TOKEN environment variable
        nitro_auth_token: "{{ login_result.sessionid }}"

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

state:
    choices:
    - present
    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 created if needed and configured according
      to the module's parameters.
    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. `logout` module always
    returns `true` unless it fails.
  returned: always
  sample: true
  type: bool
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