netscaler.adc.nscapacity (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 capacity resource.

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

unit:
    choices:
    - Gbps
    - Mbps
    description:
    - Bandwidth unit.
    type: str

vcpu:
    description:
    - licensed using vcpu pool.
    type: bool

state:
    choices:
    - present
    - 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(unset), the resource will be unset on the NetScaler ADC node.
    type: str

nodeid:
    description:
    - Unique number that identifies the cluster node.
    type: float

edition:
    choices:
    - Standard
    - Enterprise
    - Platinum
    description:
    - Product edition.
    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

platform:
    choices:
    - VS10
    - VE10
    - VP10
    - VS25
    - VE25
    - VP25
    - VS50
    - VE50
    - VP50
    - VS200
    - VE200
    - VP200
    - VS1000
    - VE1000
    - VP1000
    - VS3000
    - VE3000
    - VP3000
    - VS5000
    - VE5000
    - VP5000
    - VS8000
    - VE8000
    - VP8000
    - VS10000
    - VE10000
    - VP10000
    - VS15000
    - VE15000
    - VP15000
    - VS25000
    - VE25000
    - VP25000
    - VS40000
    - VE40000
    - VP40000
    - VS100000
    - VE100000
    - VP100000
    - CP1000
    description:
    - appliance platform type.
    type: str

bandwidth:
    description:
    - System bandwidth limit.
    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