Parameter |
Choices/Defaults |
Comments |
annotation
string
|
|
User-defined string for annotating an object.
If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.
|
certificate_name
string
|
|
The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.
If a private_key filename was provided, this defaults to the private_key basename, without extension.
If PEM-formatted content was provided for private_key , this defaults to the username value.
If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.
aliases: cert_name
|
controls
list
/ elements=string
|
Choices:
- advert-subnet
- bfd
- mtu-ignore
- passive
|
The interface policy controls.
This is a list of one or more of the following controls:
advert-subnet -- Advertise IP subnet instead of a host mask in the router LSA.
bfd -- Bidirectional Forwarding Detection
mtu-ignore -- Disables MTU mismatch detection on an interface.
passive -- The interface does not participate in the OSPF protocol and will not establish adjacencies or send routing updates. However the interface is announced as part of the routing network.
|
cost
integer
|
|
The OSPF cost of the interface.
The cost (also called metric) of an interface in OSPF is an indication of the overhead required to send packets across a certain interface. The cost of an interface is inversely proportional to the bandwidth of that interface. A higher bandwidth indicates a lower cost. There is more overhead (higher cost) and time delays involved in crossing a 56k serial line than crossing a 10M ethernet line. The formula used to calculate the cost is cost= 10000 0000/bandwith in bps For example, it will cost 10 EXP8/10 EXP7 = 10 to cross a 10M Ethernet line and will cost 10 EXP8/1544000 = 64 to cross a T1 line.
By default, the cost of an interface is calculated based on the bandwidth; you can force the cost of an interface with the ip ospf cost value interface subconfiguration mode command.
Accepted values range between 1 and 450 .
The APIC defaults to 0 when unset during creation.
|
dead_interval
integer
|
|
The interval between hello packets from a neighbor before the router declares the neighbor as down.
This value must be the same for all networking devices on a specific network.
Specifying a smaller dead interval (seconds) will give faster detection of a neighbor being down and improve convergence, but might cause more routing instability.
Accepted values range between 1 and 65535 .
The APIC defaults to 40 when unset during creation.
|
description
string
|
|
The description for the OSPF interface.
aliases: descr
|
hello_interval
integer
|
|
The interval between hello packets that OSPF sends on the interface.
Note that the smaller the hello interval, the faster topological changes will be detected, but more routing traffic will ensue.
This value must be the same for all routers and access servers on a specific network.
Accepted values range between 1 and 65535 .
The APIC defaults to 10 when unset during creation.
|
host
string
/ required
|
|
IP Address or hostname of APIC resolvable by Ansible control host.
If the value is not specified in the task, the value of environment variable ACI_HOST will be used instead.
aliases: hostname
|
name_alias
string
|
|
The alias for the current object. This relates to the nameAlias field in ACI.
|
network_type
string
|
|
The OSPF interface policy network type.
OSPF supports broadcast and point-to-point.
The APIC defaults to unspecified when unset during creation.
|
ospf
string
|
|
The OSPF interface policy name.
This name can be between 1 and 64 alphanumeric characters.
Note that you cannot change this name after the object has been saved.
aliases: ospf_interface, name
|
output_level
string
|
Choices:
- debug
- info
normal ←
|
Influence the output of this ACI module.
normal means the standard output, incl. current dict
info adds informational output, incl. previous , proposed and sent dicts
debug adds debugging output, incl. filter_string , method , response , status and url information
If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.
|
output_path
string
|
|
Path to a file that will be used to dump the ACI JSON configuration objects generated by the module.
If the value is not specified in the task, the value of environment variable ACI_OUTPUT_PATH will be used instead.
|
owner_key
string
|
|
User-defined string for the ownerKey attribute of an ACI object.
This attribute represents a key for enabling clients to own their data for entity correlation.
If the value is not specified in the task, the value of environment variable ACI_OWNER_KEY will be used instead.
|
owner_tag
string
|
|
User-defined string for the ownerTag attribute of an ACI object.
This attribute represents a tag for enabling clients to add their own data.
For example, to indicate who created this object.
If the value is not specified in the task, the value of environment variable ACI_OWNER_TAG will be used instead.
|
password
string
|
|
The password to use for authentication.
This option is mutual exclusive with private_key . If private_key is provided too, it will be used instead.
If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.
|
port
integer
|
|
Port number to be used for REST connection.
The default value depends on parameter use_ssl .
If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.
|
prefix_suppression
boolean
|
|
Whether prefix suppressions is enabled or disabled.
The APIC defaults to inherit when unset during creation.
|
priority
integer
|
|
The priority for the OSPF interface profile.
Accepted values ranges between 0 and 255 .
The APIC defaults to 1 when unset during creation.
|
private_key
string
|
|
Either a PEM-formatted private key file or the private key content used for signature-based authentication.
This value also influences the default certificate_name that is used.
This option is mutual exclusive with password . If password is provided too, it will be ignored.
If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY will be used instead.
aliases: cert_key
|
retransmit_interval
integer
|
|
The interval between LSA retransmissions.
The retransmit interval occurs while the router is waiting for an acknowledgement from the neighbor router that it received the LSA.
If no acknowledgment is received at the end of the interval, then the LSA is resent.
Accepted values range between 1 and 65535 .
The APIC defaults to 5 when unset during creation.
|
state
string
|
Choices:
- absent
present ←
- query
|
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
|
tenant
string
|
|
The name of the Tenant the OSPF interface policy should belong to.
aliases: tenant_name
|
timeout
integer
|
Default:
30
|
The socket level timeout in seconds.
If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.
|
transmit_delay
integer
|
|
The delay time needed to send an LSA update packet.
OSPF increments the LSA age time by the transmit delay amount before transmitting the LSA update.
You should take into account the transmission and propagation delays for the interface when you set this value.
Accepted values range between 1 and 450 .
The APIC defaults to 1 when unset during creation.
|
use_proxy
boolean
|
|
If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts.
If the value is not specified in the task, the value of environment variable ACI_USE_PROXY will be used instead.
|
use_ssl
boolean
|
|
If no , an HTTP connection will be used instead of the default HTTPS connection.
If the value is not specified in the task, the value of environment variable ACI_USE_SSL will be used instead.
|
username
string
|
Default:
"admin"
|
The username to use for authentication.
If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.
aliases: user
|
validate_certs
boolean
|
|
If no , SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.
If the value is not specified in the task, the value of environment variable ACI_VALIDATE_CERTS will be used instead.
|