Documentation

aci_interface_policy_ospf – Manage OSPF interface policies (ospf:IfPol)

New in version 2.7.

Synopsis

  • Manage OSPF interface policies on Cisco ACI fabrics.

Parameters

Parameter Choices/Defaults Comments
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.

aliases: cert_name
controls
list
    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.

aliases: hostname
network_type
string
    Choices:
  • bcast
  • p2p
The OSPF interface policy network type.
OSPF supports broadcast and point-to-point.
The APIC defaults to unspecified when unset during creation.
ospf
string / required
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
password
string / required
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.
port
integer
Port number to be used for REST connection.
The default value depends on parameter use_ssl.
prefix_suppression
boolean
    Choices:
  • no
  • yes
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 / required
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.

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 acknowlegment 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 / required
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.
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
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
boolean
    Choices:
  • no
  • yes ←
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
string
Default:
"admin"
The username to use for authentication.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only set to no when used on personally controlled sites using self-signed certificates.

See Also

See also

APIC Management Information Model reference
More information about the internal APIC class ospf:IfPol.
Cisco ACI Guide
Detailed information on how to manage your ACI infrastructure using Ansible.
Developing Cisco ACI modules
Detailed guide on how to write your own Cisco ACI modules to contribute.

Examples

- name: Ensure ospf interface policy exists
  aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Ensure ospf interface policy does not exist
  aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Query an ospf interface policy
  aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all ospf interface policies in tenant production
  aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
current
list
success
The existing configuration from the APIC after the module has finished

Sample:
[{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production environment', 'nameAlias': '', 'ownerTag': ''}}}]
error
dictionary
failure
The error information as returned from the APIC

Sample:
{'text': 'unknown managed object class foo', 'code': '122'}
filter_string
string
failure or debug
The filter string used for the request

Sample:
?rsp-prop-include=config-only
method
string
failure or debug
The HTTP method used for the request to the APIC

Sample:
POST
previous
list
info
The original configuration from the APIC before the module has started

Sample:
[{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Production', 'nameAlias': '', 'ownerTag': ''}}}]
proposed
dictionary
info
The assembled configuration from the user-provided parameters

Sample:
{'fvTenant': {'attributes': {'name': 'production', 'descr': 'Production environment'}}}
raw
string
parse error
The raw output returned by the APIC REST API (xml or json)

Sample:
<?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response
string
failure or debug
The HTTP response from the APIC

Sample:
OK (30 bytes)
sent
list
info
The actual/minimal configuration pushed to the APIC

Sample:
{'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status
integer
failure or debug
The HTTP status from the APIC

Sample:
200
url
string
failure or debug
The HTTP url used for the request to the APIC

Sample:
https://10.11.12.13/api/mo/uni/tn-production.json


Status

Authors

  • Dag Wieers (@dagwieers)

Hint

If you notice any issues in this documentation you can edit this document to improve it.