Try SpotterConfiguration for route resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for route resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | route
delegate_to: localhost
netscaler.adc.route:
state: present
network: 172.31.0.0
netmask: 255.255.0.0
gateway: 172.31.0.1
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
msr:
choices:
- ENABLED
- DISABLED
description:
- Monitor this route using a monitor of type ARP or PING.
type: str
cost:
description:
- Positive integer used by the routing algorithms to determine preference for using
this route. The lower the cost, the higher the preference.
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
vlan:
description:
- VLAN as the gateway for this route.
type: float
cost1:
description:
- 'The cost of a route is used to compare routes of the same type. The route having
the lowest cost is the most preferred route. Possible values: 0 through 65535. Default:
0.'
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
detail:
description:
- Display a detailed view.
type: bool
weight:
description:
- Positive integer used by the routing algorithms to determine preference for this
route over others of equal cost. The lower the weight, the higher the preference.
type: float
gateway:
description:
- IP address of the gateway for this route. Can be either the IP address of the gateway,
or can be null to specify a null interface route.
type: str
monitor:
description:
- Name of the monitor, of type ARP or PING, configured on the Citrix ADC to monitor
this route.
type: str
netmask:
description:
- The subnet mask associated with the network address.
type: str
network:
description:
- IPv4 network address for which to add a route entry in the routing table of the
Citrix ADC.
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
distance:
description:
- Administrative distance of this route, which determines the preference of this route
over other routes, with same destination, from different routing protocols. A lower
value is preferred.
type: float
protocol:
choices:
- OSPF
- ISIS
- RIP
- BGP
description:
- Routing protocol used for advertising this route.
elements: str
type: list
advertise:
choices:
- DISABLED
- ENABLED
description:
- Advertise this route.
type: str
routetype:
choices:
- CONNECTED
- STATIC
- DYNAMIC
- OSPF
- ISIS
- RIP
- BGP
description:
- Protocol used by routes that you want to remove from the routing table of the Citrix
ADC.
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
ownergroup:
description:
- The owner node group in a Cluster for this route. If owner node group is not specified
then the route is treated as Striped route.
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
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