netscaler / netscaler.adc / 2.5.1 / module / netprofile Configuration for Network profile resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.netprofile (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for Network profile resource.
--- - name: Sample Playbook hosts: localhost gather_facts: false tasks: - name: Add IPSet delegate_to: localhost netscaler.adc.ipset: state: present name: ipset-001 - name: Sample Task | netProfile delegate_to: localhost netscaler.adc.netprofile: state: present name: netprofile-001 srcip: ipset-001 mbf: DISABLED
td: description: - Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. type: float mbf: choices: - ENABLED - DISABLED description: - Response will be sent using learnt info if enabled. When creating a netprofile, if you do not set this parameter, the netprofile inherits the global MBF setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the netprofile type: str name: description: - Name for the net profile. Must begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore characters. Cannot be changed after the profile is created. Choose a name that helps identify the net profile. 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 srcip: description: - IP address or the name of an IP set. type: str state: choices: - present - absent - 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(absent), the resource will be deleted from the NetScaler ADC node. - When C(unset), the resource will be unset 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 overridelsn: choices: - ENABLED - DISABLED description: - USNIP/USIP settings override LSN settings for configured - ' service/virtual server traffic..' 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 proxyprotocol: choices: - ENABLED - DISABLED description: - Proxy Protocol Action (Enabled/Disabled) 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 nitro_auth_token: description: - The authentication token provided by a login operation. type: str version_added: 2.6.0 version_added_collection: netscaler.adc srcippersistency: choices: - ENABLED - DISABLED description: - When the net profile is associated with a virtual server or its bound services, this option enables the Citrix ADC to use the same address, specified in the net profile, to communicate to servers for all sessions initiated from a particular client to the virtual server. type: str proxyprotocoltxversion: choices: - V1 - V2 description: - Proxy Protocol Version (C(V1)/C(V2)) type: str netprofile_natrule_binding: description: Bindings for netprofile_natrule_binding resource suboptions: binding_members: default: [] description: List of binding members elements: dict type: list mode: choices: - desired - bind - unbind default: desired description: - The mode in which to configure the bindings. - If mode is set to C(desired), the bindings will be added or removed from the target NetScaler ADCs as necessary to match the bindings specified in the state. - If mode is set to C(bind), the specified bindings will be added to the resource. The existing bindings in the target ADCs will not be modified. - If mode is set to C(unbind), the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified. type: str type: dict netprofile_srcportset_binding: description: Bindings for netprofile_srcportset_binding resource suboptions: binding_members: default: [] description: List of binding members elements: dict type: list mode: choices: - desired - bind - unbind default: desired description: - The mode in which to configure the bindings. - If mode is set to C(desired), the bindings will be added or removed from the target NetScaler ADCs as necessary to match the bindings specified in the state. - If mode is set to C(bind), the specified bindings will be added to the resource. The existing bindings in the target ADCs will not be modified. - If mode is set to C(unbind), the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified. type: str type: dict proxyprotocolaftertlshandshake: choices: - ENABLED - DISABLED description: - ADC doesnt look for proxy header before TLS handshake, if enabled. Proxy protocol parsed after TLS handshake type: str
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