a10_router_ospf_area

Synopsis

OSPF area parameters

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

ospf_process_id

str/required

Key to identify parent object

area_ipv4

str/required

OSPF area ID in IP address format

area_num

int/required

OSPF area ID as a decimal value

auth_cfg

dict

Field auth_cfg

authentication

bool

Enable authentication

message_digest

bool

Use message-digest authentication

filter_lists

list

Field filter_lists

filter_list

bool

Filter networks between OSPF areas

acl_name

str

Filter networks by access-list (Name of an access-list)

acl_direction

str

‘in’= Filter networks sent to this area; ‘out’= Filter networks sent from this area;

plist_name

str

Filter networks by prefix-list (Name of an IP prefix-list)

plist_direction

str

‘in’= Filter networks sent to this area; ‘out’= Filter networks sent from this area;

nssa_cfg

dict

Field nssa_cfg

nssa

bool

Specify a NSSA area

no_redistribution

bool

No redistribution into this NSSA area

no_summary

bool

Do not send summary LSA into NSSA

translator_role

str

‘always’= Translate always; ‘candidate’= Candidate for translator (default); ‘never’= Do not translate;

default_information_originate

bool

Originate Type 7 default into NSSA area

metric

int

OSPF default metric (OSPF metric)

metric_type

int

OSPF metric type (OSPF metric type for default routes)

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

area_range_prefix

str

Area range for IPv4 prefix

option

str

‘advertise’= Advertise this range (default); ‘not-advertise’= DoNotAdvertise this range;

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

stub

bool

Configure OSPF area as stub

no_summary

bool

Do not inject inter-area routes into area

virtual_link_list

list

Field virtual_link_list

virtual_link_ip_addr

str

ID (IP addr) associated with virtual link neighbor

bfd

bool

Bidirectional Forwarding Detection (BFD)

hello_interval

int

Hello packet interval (Seconds)

dead_interval

int

Dead router detection time (Seconds)

retransmit_interval

int

LSA retransmit interval (Seconds)

transmit_delay

int

LSA transmission delay (Seconds)

virtual_link_authentication

bool

Enable authentication

virtual_link_auth_type

str

‘message-digest’= Use message-digest authentication; ‘null’= Use null authentication;

authentication_key

str

Set authentication key (Authentication key (8 chars))

message_digest_key

int

Set message digest key (Key ID)

md5

str

Use MD5 algorithm (Authentication key (16 chars))

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.

Authors

  • A10 Networks