IBM Support

Adding an interface

Product Documentation


Abstract

This information describes how to add an IPv4 interface to your z/OS network.

Content


Before you begin:

  • Decide whether you will use static or dynamic routing for the interface.
  • Decide whether you will add the interface dynamically or at Startup
Basic steps:
  1. Configure the device in VTAM.
  2. If you are using dynamic routing, configure the interface for dynamic routing.
  3. Configure the interface in TCP/IP.
  4. If you are using static routing, configure the interface for static routing.

The following sections provide details for these basic steps.

1. Configure the device in VTAM
Before you begin, ensure you have the proper definitions for the device, depending on the type of device you are using. Here are some of the things that need to be configured in VTAM for TCP/IP devices:
  • For ATM, OSA-Express QDIO MPCIPA (QDIO), MPCOSA, MPCPTP devices -- Define a TRLE
  • For OSA-Express QDIO -- Ensure the port name in the TRLE matches the device name
  • For XCF and dynamic XCF devices -- Specify XCFINIT=YES or XCFINIT=DEFINE
For all other devices, the VTAM configuration is autogenerated.

Here is a pointer to the chapter on Implementing a VTAM Network in the z/OS V1R13 Communications Server: SNA Network Implementation Guide.


2. If you are using dynamic routing, configure the interface for dynamic routing

Before you begin,
1. Do one of the following, depending on whether you are using OSPF, RIP, or no routing protocol for the interface.
    If you are using the RIP protocol for this interface, perform the following steps.
      Before you begin, determine the following (by working with your network administrator):
      • The cost of this interface
      • Whether you are using RIP v1 or RIP v2

      Steps:
      1. Code a RIP Interface statement in the OMPROUTE configuration file.
        Here is a sample RIP Interface statement using RIP v2.
          RIP_INTERFACE
              IP_Address=192.60.41.1
              Name=OSALINK1
              Subnet_mask=255.255.255.0
              MTU=1492
              RIPV2=Yes;

        Here is a sample RIP Interface statement using RIP v1.
          RIP_INTERFACE
              IP_Address=192.60.41.1
              Name=OSALINK1
              Subnet_mask=255.255.255.0

               MTU=1492
              RIPV2=No;
    If you are using the OSPF protocol for this interface, perform the following steps.
      Before you begin, determine the following (by working with your network administrator):
      • Hello interval
      • Dead router interval
      • OSPF area that the interface will attach to and, if this is the first attachment to that area, area type (stub or non-stub)
      • The cost of this interface
      • Router priority

      Steps:
      1. Code an OSPF Interface statement in the OMPROUTE configuration file. Here is a sample OSPF Interface statement.
          OSPF_INTERFACE
              IP_Address=192.60.41.1
              Name=OSALINK1
              Subnet_mask=255.255.255.0
              MTU=1492
              Attaches_to_Area=1.1.1.1
              Cost0=200
              Hello_Interval=10
              Dead_Router_Interval=40
              Router_Priority=0;
      2. If this interface is the first interface on this stack to attach to this OSPF area, code the Area statement in the OMPROUTE configuration file. Here is a sample Area statement.
          AREA
              Area_Number=1.1.1.1;

    If you are not using a routing protocol for this interface, code an Interface statement in the OMPROUTE configuration file. Here is a sample Interface statement.
      INTERFACE
          IP_Address=192.60.41.1
          Name=OSALINK1
          MTU=1492
          Subnet_mask=255.255.255.0;

2. Restart or dynamically update OMPROUTE.
    Guideline: You cannot dynamically update OMPROUTE if you added an AREA statement. OMPROUTE must be restarted for this change to take effect.

    Use the following command if you can dynamically update OMPROUTE:

       F omproute_jobname,RECONFIG

    The following messages will be displayed on the console:
      EZZ7866I OMPROUTE MODIFY COMMAND ACCEPTED
      EZZ8073I DYNAMICALLY ADDED intf_type OSALINK1 TO OMPROUTE CONFIGURATION
    where intf_type indicates the type of interface statement that was used (OSPF_INTERFACE, RIP_INTERFACE, or INTERFACE).

    Message EZZ7821I will be issued for any interfaces that were previously defined to OMPROUTE. This does not indicate an error.
      EZZ7821I IGNORING DUPLICATE intf_type STATEMENT FOR 9.42.130.132

3. Issue a DISPLAY command to verify your OMPROUTE changes.
  • If you added an OSPF Interface statement, issue the following command:

  • D TCPIP,tcpipprocname,OMPROUTE,OSPF,LIST,IFS

    The following report is displayed:
    EZZ7833I INTERFACE CONFIGURATION 275
    IP ADDRESS  AREA    COST RTRNS TRDLY PRI HELLO DEAD DB_EX
    192.60.41.1 1.1.1.1    2     5     1   1    10   40    40
  • If you added a RIP Interface statement, issue the following command:

  • D TCPIP,tcpipprocname,OMPROUTE,RIP,LIST,IFS  

    The following report is displayed:
    EZZ7843I RIP CONFIGURATION 508
    TRACE: 0, DEBUG: 0, SADEBUG LEVEL: 0
    STACK AFFINITY: TCPCS
    RIP: ENABLED
    RIP DEFAULT ORIGINATION: ALWAYS, COST = 1
    PER-INTERFACE ADDRESS FLAGS:
    OSALINK1  192.60.41.1  RIP-2 MULTICAST
                           SEND NET AND SUBNET ROUTES
                           RECEIVE NO DYNAMIC HOST ROUTES
                           RIP INTERFACE INPUT METRIC: 1
                           RIP INTERFACE OUTPUT METRIC: 0
                           RIP RECEIVE CONTROL: RIP2
  • If you added an Interface statement, issue the following command:

  • D TCPIP,tcpipprocname,OMPROUTE,GENERIC,LIST,IFS

    The following report is displayed:
    EZZ8056I IPV4 GEN INT CONFIGURATION 638                
    IFC NAME   IFC ADDRESS   SUBNET MASK      MTU DESTADDR  
    OSALINK1   192.60.41.1   255.255.255.0   1492  N/A      


3. Configure the interface in TCP/IP

You can configure the interface in TCP/IP either at startup or dynamically.

Configuring the interface at startup
To configure the interface at startup, perform these steps:

Before you begin:
  • Know the device type and find the appropriate device and link statement in the z/OS V1R13 Communications Server: IP Configuration Reference. The example presented here is for an OSA device.
  • Know the IP address of the interface
  • Know the name that you will use for the interface
  • Locate the profile data set for the TCP/IP stack (containing the Device, Link, and Home statements)
  • If sourcevipa is configured, decide where to place the new interface, in relation to the static VIPAs in the Home statement.
Guideline: If sourcevipa is not configured, plan to add this interface at the bottom of the Home statement.

Steps:
1. Code the device and link statements for this interface in the TCP/IP profile data set.
    Here is an example of an OSA card configured for Gigabit Ethernet:
        DEVICE OSAPORT1 MPCIPA NONROUTER
        LINK OSALINK1 IPAQENET OSAPORT1

    Here is the coordinating TRLE definition:
        OSA11 TRLE LNCTL=MPC, READ=100,WRITE=101,
              MPCLEVEL=QDIO,DATAPATH=(102,103),
              PORTNAME=OSAPORT1

    Read about how to set up TRL definitions in the z/OS V1R13 Communications Server: Resource Definition Guide.
2. Add the IP address to the existing Home statement in the TCP/IP profile data set.
        HOME
          ... (Existing Home definition)
          192.60.41.1  OSALINK1
          .... (Existing Home definition)

3. Add a Start statement for this device to the TCP/IP profile data set.
        START OSAPORT1

You have successfully completed this task when you start the TCP/IP stack and can verify that the device is set up correctly by receiving message EZZ4313I.
    EZZ4313I INITIALIZATION COMPLETE FOR DEVICE OSAPORT1

Use the Netstat DEvlinks/-d or Netstat HOme/-h commands to verify the interface is set up correctly.

Configuring the interface dynamically for TCP/IP
To configure the interface dynamically, perform these steps:

Before you begin: Guideline: If sourcevipa is not configured, plan to add this interface at the bottom of the Home statement.

Steps:
1. Create a data set for the OBEYFILE command.

2. Code the device and link statements for this interface.
    Here is an example of an OSA card configured for Gigabit Ethernet:
        DEVICE OSAPORT1 MPCIPA NONROUTER
        LINK OSALINK1 IPAQENET OSAPORT1
 
3. Code an updated Home statement by adding the IP address for this interface to the existing Home entries.
Requirements:
  • The HOME statement must be in the file created for the OBEYFILE command.
  • It must contain all of the currently defined home entries, whether from the original profile or from a subsequent obeyfile.

  •     HOME
          ... (Existing Home definition)
          192.60.41.1  OSALINK1
          .... (Existing Home defintion)

4. Issue the VARY TCP,,OBEYFILE command to update the configuration
    v tcpip,,o,user.tcpparms(obeyfile)

The following messages are displayed:

    EZZ0060I PROCESSING COMMAND: VARY TCPIP,,O,USER.TCPPARMS(OBEYFILE)
    EZZ0300I OPENED OBEYFILE FILE 'USER.TCPPARMS(OBEYFILE)'
    EZZ0309I PROFILE PROCESSING BEGINNING FOR 'USER.TCPPARMS(OBEYFILE)'
    EZZ0316I PROFILE PROCESSING COMPLETE FOR FILE 'USER.TCPPARMS(OBEYFILE)'
    EZZ0053I COMMAND VARY OBEY COMPLETED SUCCESSFULLY

You have successfully completed this task when you can verify the device is set up correctly by receiving message EZZ4313I.
    EZZ4313I INITIALIZATION COMPLETE FOR DEVICE OSAPORT1

Use the Netstat DEvlinks/-d or Netstat HOme/-h commands to verify the interface is set up correctly.


4. If you are using static routing, configure the interface for static routing

Making static route changes at startup
Before you begin,
  • Configure the device, link, and home statements in the stack
  • Know the following:
    • Location of the profile data set
    • IP network or subnet that the mainframe is directly connected to over the interface, reachable without going through an intermediate router.
    • IP networks and subnets that are reachable over the interface by going through intermediate routers, and the IP addresses of those intermediate routers
    • MTU supported by the link type and conducive to the network performance (from your network administrator)
  • Decide whether you are using the BEGINROUTES or GATEWAY statement.

Steps:
1. Code the BEGINROUTES or GATEWAY statement, with a direct route for the IP network or subnet that the mainframe is directly connected to over the interface.
  • BEGINROUTES
    ;     Destination     First Hop    Link     Packet Size
    ROUTE 192.60.41.0/24  =            OSALINK1 MTU 1492
    ENDROUTES
  • GATEWAY
    ;                                  Subnet      Subnet

  • ;Network  First Hop  Link     MTU  Mask        Value
    192.60.41 =          OSALINK1 1492 0           0

2. Add any indirect routes for IP networks and subnets that are reachable over the interface by going through intermediate routers.
  • BEGINROUTES
    ;     Destination     First Hop    Link     Packet Size
    ROUTE 192.60.41.0/24  =            OSALINK1 MTU 1492
    ROUTE 10.1.2.0/24     192.60.41.1  OSALINK1 MTU 1492
    ROUTE DEFAULT         192.60.41.2  OSALINK1 MTU 1492
    ENDROUTES
  • GATEWAY
    ;                                   Subnet      Subnet

  • ;Network  First Hop   Link     MTU  Mask        Value
    192.60.41 =           OSALINK1 1492 0           0
    10        192.60.41.1 OSALINK1 1492 0.255.255.0 0.1.2.0
    DEFAULT   192.60.41.2 OSALINK1 1492 0
3. Restart the stack.

You have successfully completed this task when you verify, using the Netstat ROUTe/-r command, that the static routes were added to the route table.
EZD0101I NETSTAT CS V1R9 TCPCS 111                              
IPV4 DESTINATIONS                                              
DESTINATION      GATEWAY       FLAGS   REFCNT  INTERFACE
DEFAULT          192.60.41.2   UGS     000000  OSALINK1
10.1.2.0/24      192.60.41.1   UGS     000000  OSALINK1
192.60.41.0/24   0.0.0.0       US      000000  OSALINK1

Making static route changes dynamically
Before you begin,
  • Configure the device, link, and home statements in the stack
  • Know the following:
    • Location of the profile data set
    • IP network or subnet that the mainframe is directly connected to over the interface, reachable without going through an intermediate router.
    • IP networks and subnets that are reachable over the interface by going through intermediate routers, and the IP addresses of those intermediate routers
    • MTU supported by the link type and conducive to the network performance (from your network administrator)
  • Decide whether you are using the BEGINROUTES or GATEWAY statement.

Steps:
1. Create a data set for the OBEYFILE command.

2. Code a BEGINROUTES or GATEWAY statement that will contain only static routes for the interface or modify the existing BEGINROUTES or GATEWAY statement from the profile data set, adding static routes for the interface.
  • BEGINROUTES

  • ;     Destination     First Hop    Link     Packet Size
    ROUTE 192.60.41.0/24  =            OSALINK1 MTU 1492
    ROUTE 10.1.2.0/24     192.60.41.1  OSALINK1 MTU 1492
    ROUTE DEFAULT         192.60.41.2  OSALINK1 MTU 1492
    ENDROUTES
  • GATEWAY

  • ;                                   Subnet      Subnet
    ;Network  First Hop   Link     MTU  Mask        Value
    192.60.41 =           OSALINK1 1492 0           0
    10        192.60.41.1 OSALINK1 1492 0.255.255.0 0.1.2.0
    DEFAULT   192.60.41.2 OSALINK1 1492 0
    Rule: Ensure the OBEYFILE data set contains the complete set of routing statements to be included in the route table. Otherwise, all previously existing static routes will be deleted from the route table.

    Tip: To remove all static routes from the routing table, specify an empty BEGINROUTES or GATEWAY statement.

3. Issue the VARY TCP,,OBEYFILE command to update the configuration
    v tcpip,,o,user.tcpparms(obeyfile)

The following messages are displayed:
    EZZ0060I PROCESSING COMMAND: VARY TCPIP,,O,USER.TCPPARMS(OBEYFILE)
    EZZ0300I OPENED OBEYFILE FILE 'USER.TCPPARMS(OBEYFILE)'
    EZZ0309I PROFILE PROCESSING BEGINNING FOR 'USER.TCPPARMS(OBEYFILE)'
    EZZ0316I PROFILE PROCESSING COMPLETE FOR FILE 'USER.TCPPARMS(OBEYFILE)'
    EZZ0053I COMMAND VARY OBEY COMPLETED SUCCESSFULLY
You have successfully completed this task when you verify, using the Netstat ROUTe/-r command, that the route table was updated.
EZD0101I NETSTAT CS V1R9 TCPCS 111                              
IPV4 DESTINATIONS                                              
DESTINATION      GATEWAY       FLAGS   REFCNT  INTERFACE
DEFAULT          192.60.41.2   UGS     000000  OSALINK1
10.1.2.0/24      192.60.41.1   UGS     000000  OSALINK1
192.60.41.0/24   0.0.0.0       US      000000  OSALINK1

[{"Product":{"code":"SSSN3L","label":"z\/OS Communications Server"},"Business Unit":{"code":"BU054","label":"Systems w\/TPS"},"Component":"Not Applicable","Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"1.7;1.8;1.9;1.10;1.11;1.12;1.13;2.1","Edition":"All Editions","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
17 June 2018

UID

swg27011208