Add OSPF Interface (ADDOSPFIFC)
Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Add OSPF Interface (ADDOSPFIFC) command defines an OSPF interface that the OMPROUTED server will add into the OSPF routing protocol implementation and set the different parameters needed for each interface.
With this command both IPv4 and IPv6 OSPF Interfaces can be configured.
Restrictions:
- You must have input/output system configuration (*IOSYSCFG) special authority to run this command.
Top |
Parameters
Keyword | Description | Choices | Notes |
---|---|---|---|
IFC | Interface identifier | Character value, *PPPCNNPRF, *PPP6CNNPRF | Required, Positional 1 |
PPPCNNPRF | Connection profile | Character value, *NONE | Optional |
AREA | Area identifier | Character value, *BACKBONE | Optional |
RETMSITV | Retransmission interval | 1-65535, 5 | Optional |
TMSDLY | Transmission delay | 1-65535, 1 | Optional |
RTRPTY | Router priority | 1-255, 1 | Optional |
ITVHELLO | Interval for hello | 1-255, 10 | Optional |
DBEXCHTIMO | Database exchange timeout | 2-65535, 40 | Optional |
INACTTIMO | Inactive router timeout | 2-65535, 40 | Optional |
COST | Cost | 1-65535, 1 | Optional |
IFCUSG | Interface usage | *PRIMARY, *BACKUP | Optional |
SUBNET | Subnet | *NO, *YES | Optional |
AUTHTYPE | Authentication type | *AREA, *NONE, *MD5, *PASSWORD | Optional |
AUTHVAL | Authentication values | Element list | Optional |
Element 1: Authentication key identifier | 1-255 | ||
Element 2: Authentication key | Character value | ||
DMDCCT | Demand circuit | *NO, *YES | Optional |
SUPHELLO | Suppression of hello | *ALLOW, *DISABLE, *REQUEST | Optional |
PTPPOLLITV | Point-to-point poll interval | 0-65535, 60 | Optional |
NBCLNK | Nonbroadcast link | *DFT, *NO, *YES | Optional |
NBCPOLLITV | Nonbroadcast interval | 1-65535, 120 | Optional |
NGHRTRL | Neighbor router list | Values (up to 10 repetitions): Element list | Optional |
Element 1: Internet address | Character value | ||
Element 2: Eligible | *NO, *YES | ||
INSTANCE | Instance | Integer, 0 | Optional |
Top |
Interface identifier (IFC)
Specifies the internet address of a configured logical interface in the system. The interface identifier can be an IPv4 or IPv6 address.
- *PPPCNNPRF
- The point-to-point connection profile specified for the Connection profile (PPPCNNPRF) parameter is used to send and receive OSPF routing traffic over an IPv4 point-to- point link.
- *PPP6CNNPRF
- The point-to-point connection profile specified for the Connection profile (PPPCNNPRF) parameter is used to send and receive OSPF routing traffic over an IPv6 point-to-point link.
- character-value
- Specify the internet address of the OSPF interface to add. An IPv4 internet address is specified in the form nnn.nnn.nnn.nnn where nnn is a decimal number between 0 and 255. An IPv6 internet address is specified in the form n:n:n:n:n:n:n:n where n is a hexadecimal number in the range from 0 through X'ffff'. The value "::" indicates that one or more groups of 16 bits are zero.
The interface identifier can also be an alias name of an logical interface.
Top |
Connection profile (PPPCNNPRF)
Specifies the profile created for point-to-point connection to a host at the remote end. This profile will be used later when the point-to-point link is being active.
- *NONE.
- Specifies that this interface will not work over a point-to-point link.
- character-value
- Specify the connection profile to be used. This profile must have been configured previuosly using Remote Access Services.
Top |
Area identifier (AREA)
Specifies the OSPF area to which this interface attaches. You can specify the backbone area (internet address 0.0.0.0) or any area previously defined by running the Add OSPF Area (ADDOSPFARA) command.
- *BACKBONE
- The backbone area is used (internet address 0.0.0.0).
- character-value
- Specify the internet address for the OSPF area in the form a.a.a.a where a is a decimal number between 1 and 255.
Top |
Retransmission interval (RETMSITV)
Specifies the frequency of retransmitting link-state update packets, link-state request packets, and database description packets.
Note: If this parameter is set too low, needless retransmissions will occur that could affect performance and interfere with neighbor adjacency establishment. It should be set to a higher value for a slower machine.
- 5
- Retransmit packets every 5 seconds.
- 1-65535
- Specify the number of seconds to use for the retransmission interval value.
Top |
Transmission delay (TMSDLY)
Specifies the estimated number of seconds that it takes to transmit link-state information over the interface.
- 1
- This interface is on a low-latency network.
- 1-65535
- Specify the number of seconds to use for the transmission delay value.
Top |
Router priority (RTRPTY)
Specifies the value for a broadcast and non-broadcast multi-access networks in order to elect a designated router. The router with the highest priority value will be elected.
- 1
- This system should not normally be used as a Designated Router.
- 1-255
- Specify the router priority value to use.
Top |
Interval for hello (ITVHELLO)
Specifies the number of seconds between OSPF hello packets to be sent out on this interface. This value must be the same for all routers attached to a common network.
- 10
- Send hello packets every 10 seconds.
- 1-65535
- Specify the number of seconds to use for the hello interval value.
Top |
Database exchange timeout (DBEXCHTIMO)
Specifies the length of time that the database exchange process cannot exceed. If the interval elapses, the procedure will be restarted. This value must be larger than the interval for hello.
- 40
- Database exchanges should be completed within 40 seconds.
- 1-65535
- Specify the number of seconds to use for the database exchange process timeout value.
Top |
Inactive router timeout (INACTTIMO)
Specifies the length of time after not having received OSPF hello packets that an OSPF neighbor is declared to be down.
- 40
- The router will be considered down after not having received hello packets in 40 seconds.
- 1-65535
- Specify the number of seconds to use for the inactive router timeout value.
Top |
Cost (COST)
Specifies the cost of sending a data packet on the interface, expressed in the link state metric. This is advertised as the link cost for this interface in the router-LSA. The cost of an interface must be greater than zero.
- 1
- This interface has the lowest possible cost.
- 1-65535
- Specify the cost value to be used.
Top |
Interface usage (IFCUSG)
Specifies whether this interface is designated as primary or backup by OSPF. When there is more than one local interface defined on the same IPv4 subnet, IPv6 subnet, or link, OSPF sends all routing traffic on the designated primary interface.
- *BACKUP
- This OSPF interface is defined as a backup interface. If the primary interface is not specified, OSPF chooses one of the backup interfaces to carry out routing traffic.
- *PRIMARY
- This OSPF interface is defined as the primary interface. OSPF sends all routing traffic over this interface.
Top |
Subnet (SUBNET)
Specifies, for Point-to-Point links, if this interfaces can have a connection to a network/subnet or host. This parameter only applies to IPv4.
- *NO
- This interface cannot have a connection to a network/subnet or host. Implements option 1 of section 12.4.1.1 of RFC 2328. It assumes that neighbor router's IP address is known.
- *YES
- This interface can have a connection to a network/subnet or host. Implements option 2 of section 12.4.1.1 of RFC 2328 if a subnet has been assigned to the point-point link.
Top |
Authentication type (AUTHTYPE)
Specifies the security schema used on the network where this interface is attached. If this parameter is not specified the security schema will be taken from the area's security schema. This parameter is ignored for OSPF IPv6 interfaces.
- *AREA
- Use the security schema defined in the OSPF area to which this interface is attached.
- *NONE
- No authentication is necessary to pass packets.
- *MD5
- MD5 cryptographic authentication is used.
- *PASSWORD
- Simple password authentication is used.
Top |
Authentication values (AUTHVAL)
Specifies the combination of parameters needed for cryptographic authentication.
Element 1: Authentication key identifier
- 0-255
- Specify the constant value to use as the key identifier. This value is only meaningful when the authentication type *MD5 is specified and is used with other routers that require identification of an authentication type.
Element 2: Authentication key
- character-value
- Specify the authentication key for this interface. This value must be the same in all routers that are attached to a common network. This value depends on the authentication type used for this interface. This parameter is ignored for OSPF IPv6.
For *NONE authentication type, this parameter element is not required and is ignored if specified.
For authentication type *PASSWORD, this parameter element must specify a password for OSPF routers that are attached to this subnet. Valid values are any character string up to 8 characters in length coded within single quotation marks, or any hexadecimal string up to 8 bytes (16 hexadecimal characters) long beginning with X followed by the hexadecimal value enclosed in single quotation marks.
For authentication type *MD5, this parameter must specify the 16-byte MD5 authentication key for OSPF routers attached to this subnet. The standard method is with a 16-byte hexadecimal string beginning with X followed by the hexadecimal value enclosed in single quotation marks.
Top |
Demand circuit (DMDCCT)
Specifies whether link state advertisements (LSAs) are periodically refreshed or not over this interface.
Only LSAs with real changes will be advertised. This parameter is ignored by IPv6 interfaces.
- *NO
- Link state advertisements are periodically refreshed.
- *YES
- Link state advertisements are not periodically refreshed.
Top |
Suppression of hello (SUPHELLO)
Specifies whether to allow suppression of hello packets. This support is only used for point-to-point-interface and point-to-multipoint interfaces types that are on demand circuits. This parameter only applies to IPv4.
- *ALLOW
- If both sides specify this option, hello suppression is disabled.
- *DISABLE
- If either or both sides specify this option, hello suppression is disabled.
- *REQUEST
- If both sides specify this option, hello suppression is enabled.
Top |
Point-to-point poll interval (PTPPOLLITV)
Specifies the interval time that OMPROUTED will try to re-establish a relationship with a neighboring router that has failed but the interface is still active. This parameter is used only if the interface is Point-to-Point type and suppression for hello has been enabled. This parameter is ignored for OSPF IPv6 interfaces.
- 60
- Attempt re-establishing a relationship every 60 seconds.
- 0-65535
- Specify the number of seconds to use for the point-to-point poll interval value.
Top |
Nonbroadcast link (NBCLNK)
Specifies if the router is connected to a non-broadcast or multi-access (NBMA) network.
- *DFT
- Determined by the interface type.
- *NO
- Router is not connected to a NBMA network. Neighbors are discovered by sending a broadcast packet on the network. If this option is specified for an interface on a network which does not support broadcast, neighbor discovery will fail.
- *YES
- The interface is connected to a non-broadcast network. This option can help to discover its neighbors.
Top |
Nonbroadcast interval (NBCPOLLITV)
Specifies the time interval for hello packets to be sent from this interface to neighbors that are inactive. It is only valid if *YES is specified for the Nonbroadcast link (NBCLNK) parameter.
- 120
- Attempt to send hello packets every 120 seconds.
- 1-65535
- Specify the number of seconds to be used for the non-broadcast poll interval value.
Top |
Neighbor router list (NGHRTRL)
Specifies the list of routers eligible to be treated as neighbors for this system over this interface.
Up to 10 neighboring routers can be defined.
Note: It is not necessary or recommended to define neighbors on nonbroadcast or multicast-capable media. If you do define neighbors on these media, OMPROUTED will be able to communicate OSPF information only with those neighbors that are defined (it will not form adjacencies with any additional neighbors).
Element 1: Internet address
Specifies the neighboring router's internet address.
- character-value
- Specify the internet address of the router to be eligible to be a neighbor router. An IPv4 internet address is specified in the form nnn.nnn.nnn.nnn where nnn is a decimal number between 0 and 255. An IPv6 internet address is specified in the form n:n:n:n:n:n:n:n where n is a hexadecimal number in the range from 0 through X'ffff'. The value "::" indicates that one or more groups of 16 bits are zero.
Element 2: Authentication key identifier
Specifies whether or not the neighbor router may be eligible to be a designated router.
- *NO
- This router cannot be a designated router.
- *YES
- This router can be elected as a designated router.
Top |
Instance (INSTANCE)
Specifies the IPv6 protocol instance number for this interface. This value should be the same as the instance value of other IPv6 OSPF hosts or routers that OMPROUTED communicates with on the link. This value will be set in all the outgoing IPv6 OSPF packets. All the incoming OSPF packets whose instance value does not match with the instance value set for this interface will be ignored. This characteristic permits multiples instance of IPv6 OSPF to be run on this link. OMPROUTED supports only one instance per link, however if this parameter is configured in order to interact with router that can supports multiples IPv6 OSPF instances on a link.
- 0
- Recommended default value for instance.
- 1-255
- Specify the instance value to be used.
Top |
Examples
Example 1:Adding an OSPF IPv4 Interface
ADDOSPFIFC IFC('9.67.107.7')
This command adds an OSPF IPv4 interface. The referenced logical interface must exist on the system.
Example 2:Adding an OSPF IPv6 Interface
ADDOSPFIFC IFC('1000::5678:9abc:def')
This command adds an OSPF IPv6 interface. The referenced logical interface must exist on the system.
Example 3:Adding an Interface that Will Work Over a Point-to-Point Link
ADDOSPFIFC IFC(*PPPCNNPRF) PPPCNNPRF(PROFILE1)
This command adds an OSPF IPv4 interface using a connection profile. The connection profile PROFILE1 must have already been configured using Remote Access Services.
Top |
Error messages
*ESCAPE Messages
- TCP8050
- *IOSYSCFG authority required to use &1.
- TCP6525
- Internet address &1 not valid
- TCP1902
- Internet address &1 not valid.
- TCP1908
- Internet address &1 not valid.
- TCP6524
- OSPF interface &1 has not been added successfully in configuration file. Fails with reason code &2.
- TCP9999
- Internal system error in program &1.
Top |