netscaler.adc.systementitydata (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 entity data resource.

Inputs

    
core:
    description:
    - Specify core ID of the PE in nCore.
    type: int

last:
    description:
    - 'Last is literal way of saying a certain time period from the current moment. Example:
      -last 1 hour, -last 1 day, et cetera.'
    type: int

name:
    description:
    - Specify the entity name.
    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

type:
    description:
    - Specify the entity type.
    type: str

unit:
    choices:
    - HOURS
    - DAYS
    - MONTHS
    description:
    - Specify the time period from current moment. Example 1 x where x = hours/ days/
      years.
    type: str

state:
    choices:
    - absent
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    - When C(absent), the resource will be deleted from the NetScaler ADC node.
    type: str

endtime:
    description:
    - Specify end time in mmddyyyyhhmm upto which values have to be collected.
    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

counters:
    description:
    - Specify the counters to be collected.
    type: str

starttime:
    description:
    - Specify start time in mmddyyyyhhmm to start collecting values from that timestamp.
    type: str

alldeleted:
    description:
    - Specify this if you would like to delete information about all deleted entities
      from the database.
    type: bool

datasource:
    description:
    - Specifies the source which contains all the stored counter values.
    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

allinactive:
    description:
    - Specify this if you would like to delete information about all inactive entities
      from the database.
    type: bool

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