netscaler.adc.cloudprofile (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 cloud profile resource.

Inputs

    
name:
    description:
    - Name for the Cloud profile. Must begin with an ASCII alphanumeric or underscore
      (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be
      changed after the profile is created.
    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

port:
    description:
    - Port number for the virtual server.
    type: int

type:
    choices:
    - autoscale
    - azuretags
    description:
    - Type of cloud profile that you want to create, Vserver or based on Azure Tags
    type: str

delay:
    description:
    - Time, in seconds, after which all the services configured on the server are disabled.
    type: float

state:
    choices:
    - present
    - absent
    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(absent), the resource will be deleted from 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

graceful:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Indicates graceful shutdown of the service. System will wait for all outstanding
      connections to this service to be closed before disabling the service.
    type: str

ipaddress:
    description:
    - IPv4 or IPv6 address to assign to the virtual server.
    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

servicetype:
    choices:
    - HTTP
    - FTP
    - TCP
    - UDP
    - SSL
    - SSL_BRIDGE
    - SSL_TCP
    - DTLS
    - NNTP
    - DNS
    - DHCPRA
    - ANY
    - SIP_UDP
    - SIP_TCP
    - SIP_SSL
    - DNS_TCP
    - RTSP
    - PUSH
    - SSL_PUSH
    - RADIUS
    - RDP
    - MYSQL
    - MSSQL
    - DIAMETER
    - SSL_DIAMETER
    - TFTP
    - ORACLE
    - SMPP
    - SYSLOGTCP
    - SYSLOGUDP
    - FIX
    - SSL_FIX
    - PROXY
    - USER_TCP
    - USER_SSL_TCP
    - QUIC
    - IPFIX
    - LOGSTREAM
    - MONGO
    - MONGO_TLS
    - MQTT
    - MQTT_TLS
    - QUIC_BRIDGE
    - HTTP_QUIC
    description:
    - Protocol used by the service (also called the service type).
    type: str

vservername:
    description:
    - Name for the virtual server. Must begin with an ASCII alphanumeric or underscore
      (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can
      be changed after the virtual server is created.
    - ''
    - 'CLI Users: If the name includes one or more spaces, enclose the name in double
      or single quotation marks (for example, "my vserver" or ''my vserver'').'
    type: str

azuretagname:
    description:
    - Azure tag name
    type: str

azuretagvalue:
    description:
    - Azure tag value
    type: str

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

azurepollperiod:
    description:
    - Azure polling period (in seconds)
    type: float

vsvrbindsvcport:
    description:
    - The port number to be used for the bound service.
    type: int

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

servicegroupname:
    description:
    - servicegroups bind to this server
    type: str

boundservicegroupsvctype:
    choices:
    - HTTP
    - FTP
    - TCP
    - UDP
    - SSL
    - SSL_BRIDGE
    - SSL_TCP
    - DTLS
    - NNTP
    - RPCSVR
    - DNS
    - ADNS
    - SNMP
    - RTSP
    - DHCPRA
    - ANY
    - SIP_UDP
    - SIP_TCP
    - SIP_SSL
    - DNS_TCP
    - ADNS_TCP
    - MYSQL
    - MSSQL
    - ORACLE
    - MONGO
    - MONGO_TLS
    - RADIUS
    - RADIUSListener
    - RDP
    - DIAMETER
    - SSL_DIAMETER
    - TFTP
    - SMPP
    - PPTP
    - GRE
    - SYSLOGTCP
    - SYSLOGUDP
    - FIX
    - SSL_FIX
    - USER_TCP
    - USER_SSL_TCP
    - QUIC
    - IPFIX
    - LOGSTREAM
    - LOGSTREAM_SSL
    - MQTT
    - MQTT_TLS
    - QUIC_BRIDGE
    description:
    - The type of bound service
    type: str

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