netscaler / netscaler.adc / 2.5.1 / module / vxlan Configuration for "VXLAN" resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.vxlan (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 "VXLAN" resource.
id: description: - A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. type: float 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: - Specifies UDP destination port for VXLAN packets. type: int type: choices: - VXLAN - VXLANGPE description: - C(VXLAN) encapsulation type. C(VXLAN), C(VXLANGPE) type: str vlan: description: - ID of VLANs whose traffic is allowed over this VXLAN. If you do not specify any VLAN IDs, the Citrix ADC allows traffic of all VLANs that are not part of any other VXLANs. type: float 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 protocol: choices: - IPv4 - IPv6 - ETHERNET - NSH description: - VXLAN-GPE next protocol. RESERVED, C(IPv4), C(IPv6), C(ETHERNET), C(NSH) 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 dynamicrouting: choices: - ENABLED - DISABLED description: - Enable dynamic routing on this VXLAN. 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 innervlantagging: choices: - ENABLED - DISABLED description: - Specifies whether Citrix ADC should generate VXLAN packets with inner VLAN tag. type: str nitro_auth_token: description: - The authentication token provided by a login operation. type: str version_added: 2.6.0 version_added_collection: netscaler.adc ipv6dynamicrouting: choices: - ENABLED - DISABLED description: - 'Enable all IPv6 dynamic routing protocols on this VXLAN. Note: For the C(ENABLED) setting to work, you must configure IPv6 dynamic routing protocols from the VTYSH command line.' type: str vxlan_nsip_binding: description: Bindings for vxlan_nsip_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 vxlan_nsip6_binding: description: Bindings for vxlan_nsip6_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 vxlan_srcip_binding: description: Bindings for vxlan_srcip_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 vxlanvlanmap_vxlan_binding: description: Bindings for vxlanvlanmap_vxlan_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
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