a10_router_ospf
Synopsis
Open Shortest Path First (OSPF)
Parameters
Parameters |
Choices/Defaults |
Comment |
|
---|---|---|---|
state str/required |
[‘noop’, ‘present’, ‘absent’] |
State of the object to be created. |
|
ansible_host str/required |
Host for AXAPI authentication |
||
ansible_username str/required |
Username for AXAPI authentication |
||
ansible_password str/required |
Password for AXAPI authentication |
||
ansible_port int/required |
Port for AXAPI authentication |
||
a10_device_context_id int |
[‘1-8’] |
Device ID for aVCS configuration |
|
a10_partition str |
Destination/target partition for object/command |
||
process_id int/required |
OSPF process ID |
||
auto_cost_reference_bandwidth int |
Use reference bandwidth method to assign OSPF cost (The reference bandwidth in terms of Mbits per second) |
||
bfd_all_interfaces bool |
Enable BFD on all interfaces |
||
rfc1583_compatible bool |
Compatible with RFC 1583 |
||
extern_lsa_equivalence_check bool |
external LSA equivalance check |
||
default_metric int |
Set metric of redistributed routes (Default metric) |
||
distance dict |
Field distance |
||
distance_value int |
OSPF Administrative distance |
||
distance_ospf dict |
Field distance_ospf |
||
distribute_internal_list list |
Field distribute_internal_list |
||
di_type str |
‘lw4o6’= LW4O6 Prefix; ‘floating-ip’= Floating IP; ‘ip-nat’= IP NAT; ‘ip-nat- list’= IP NAT list; ‘static-nat’= Static NAT; ‘vip’= Only not flagged Virtual IP (VIP); ‘vip-only-flagged’= Selected Virtual IP (VIP); |
||
di_area_ipv4 str |
OSPF area ID as a IP address format |
||
di_area_num int |
OSPF area ID as a decimal value |
||
di_cost int |
Cost of route |
||
distribute_lists list |
Field distribute_lists |
||
value str |
Access-list name |
||
direction str |
‘in’= Filter incoming routing updates; ‘out’= Filter outgoing routing updates; |
||
protocol str |
‘bgp’= Border Gateway Protocol (BGP); ‘connected’= Connected; ‘floating-ip’= Floating IP; ‘lw4o6’= LW4O6 Prefix; ‘ip-nat’= IP NAT; ‘ip-nat-list’= IP NAT list; ‘static-nat’= Static NAT; ‘isis’= ISO IS-IS; ‘ospf’= Open Shortest Path First (OSPF); ‘rip’= Routing Information Protocol (RIP); ‘static’= Static routes; |
||
ospf_id int |
OSPF process ID |
||
option str |
‘only-flagged’= Selected Virtual IP (VIP); ‘only-not-flagged’= Only not flagged; |
||
ha_standby_extra_cost list |
Field ha_standby_extra_cost |
||
extra_cost int |
The extra cost value |
||
group int |
Group (Group ID) |
||
host_list list |
Field host_list |
||
host_address str |
Host address |
||
area_cfg dict |
Field area_cfg |
||
log_adjacency_changes_cfg dict |
Field log_adjacency_changes_cfg |
||
state str |
‘detail’= Log changes in adjacency state; ‘disable’= Disable logging; |
||
max_concurrent_dd int |
Maximum number allowed to process DD concurrently (Number of DD process) |
||
maximum_area int |
Maximum number of non-backbone areas (OSPF area limit) |
||
neighbor_list list |
Field neighbor_list |
||
address str |
Neighbor address |
||
cost int |
OSPF cost for point-to-multipoint neighbor (Metric) |
||
poll_interval int |
OSPF dead-router polling interval (Seconds) |
||
priority int |
OSPF priority of non-broadcast neighbor |
||
network_list list |
Field network_list |
||
network_ipv4 str |
Network number |
||
network_ipv4_mask str |
OSPF wild card bits |
||
network_ipv4_cidr str |
OSPF network prefix |
||
network_area dict |
Field network_area |
||
ospf_1 dict |
Field ospf_1 |
||
abr_type dict |
Field abr_type |
||
router_id dict |
Field router_id |
||
value str |
OSPF router-id in IPv4 address format |
||
overflow dict |
Field overflow |
||
database dict |
Field database |
||
passive_interface dict |
Field passive_interface |
||
loopback_cfg list |
Field loopback_cfg |
||
trunk_cfg list |
Field trunk_cfg |
||
ve_cfg list |
Field ve_cfg |
||
tunnel_cfg list |
Field tunnel_cfg |
||
lif_cfg list |
Field lif_cfg |
||
eth_cfg list |
Field eth_cfg |
||
summary_address_list list |
Field summary_address_list |
||
summary_address str |
Configure IP address summaries (Summary prefix) |
||
not_advertise bool |
Suppress routes that match the prefix |
||
tag int |
Set tag (32-bit tag value) |
||
timers dict |
Field timers |
||
spf dict |
Field spf |
||
uuid str |
uuid of the object |
||
user_tag str |
Customized tag |
||
default_information dict |
Field default_information |
||
originate bool |
Distribute a default route |
||
always bool |
Always advertise default route |
||
metric int |
OSPF default metric (OSPF metric) |
||
metric_type int |
OSPF metric type for default routes |
||
route_map str |
Route map reference (Pointer to route-map entries) |
||
uuid str |
uuid of the object |
||
area_list list |
Field area_list |
||
area_ipv4 str |
OSPF area ID in IP address format |
||
area_num int |
OSPF area ID as a decimal value |
||
auth_cfg dict |
Field auth_cfg |
||
filter_lists list |
Field filter_lists |
||
nssa_cfg dict |
Field nssa_cfg |
||
default_cost int |
Set the summary-default cost of a NSSA or stub area (Stub’s advertised default summary cost) |
||
range_list list |
Field range_list |
||
shortcut str |
‘default’= Set default shortcutting behavior; ‘disable’= Disable shortcutting through the area; ‘enable’= Enable shortcutting through the area; |
||
stub_cfg dict |
Field stub_cfg |
||
virtual_link_list list |
Field virtual_link_list |
||
uuid str |
uuid of the object |
||
redistribute dict |
Field redistribute |
||
redist_list list |
Field redist_list |
||
ospf_list list |
Field ospf_list |
||
ip_nat bool |
IP-NAT |
||
metric_ip_nat int |
OSPF default metric (OSPF metric) |
||
metric_type_ip_nat str |
‘1’= Set OSPF External Type 1 metrics; ‘2’= Set OSPF External Type 2 metrics; |
||
route_map_ip_nat str |
Route map reference (Pointer to route-map entries) |
||
tag_ip_nat int |
Set tag for routes redistributed into OSPF (32-bit tag value) |
||
ip_nat_floating_list list |
Field ip_nat_floating_list |
||
vip_list list |
Field vip_list |
||
vip_floating_list list |
Field vip_floating_list |
||
uuid str |
uuid of the object |
Examples
Return Values
- modified_values (changed, dict, )
Values modified (or potential changes if using check_mode) as a result of task operation
- axapi_calls (always, list, )
Sequential list of AXAPI calls made by the task
- endpoint (, str, [‘/axapi/v3/slb/virtual_server’, ‘/axapi/v3/file/ssl-cert’])
The AXAPI endpoint being accessed.
- http_method (, str, [‘POST’, ‘GET’])
HTTP method being used by the primary task to interact with the AXAPI endpoint.
- request_body (, complex, )
Params used to query the AXAPI
- response_body (, complex, )
Response from the AXAPI
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.