Supplied parameters

Parameter name                 Type           Length    Default
[define_ip_port]
port_name                      character      8
description                    character      31        (null string)
dlc_name                       character      8
max_rcv_btu_size               decimal                  1461
tot_link_act_lim               decimal                  1
inb_link_act_lim               decimal                  0
out_link_act_lim               decimal                  1
nonact_xid_exchange_limit      decimal                  10
max_ifrm_rcvd                  decimal                  7
target_pacing_count            decimal                  7
max_send_btu_size              decimal                  1461
ip_version                     constant                 IPV4
implicit_cp_cp_sess_support    constant                 YES
implicit_limited_resource      constant                 NO
implicit_deact_timer           decimal                  30
implicit_uplink_to_en          constant                 NO
effect_cap                     decimal                  865075200 (Linux for System z)
                                                        157286400 (other Linux variants)
connect_cost                   decimal                  0
byte_cost                      decimal                  0
security                       constant                 SEC_NONSECURE
prop_delay                     constant                 PROP_DELAY_MINIMUM
user_def_parm_1                decimal                  0
user_def_parm_2                decimal                  0
user_def_parm_3                decimal                  0
initially_active               constant                 YES
implicit_ls_limit              decimal                  0
liveness_timeout               decimal	               10000
short_hold_mode                constant                NO
local_ip_interface             character  45

Supplied parameters are:

port_name
Name of the port to be defined. This name is a character string using any locally displayable characters.
description
A text string describing the port. CS Linux uses this string for information only. It is stored in the node's configuration file and returned on the query_port command.
dlc_name
Name of the associated DLC. This name is a character string using any locally displayable characters. The specified DLC must have already been defined.
max_rcv_btu_size
Maximum BTU size that can be received. This value includes the length of the TH and RH (total 9 bytes), as well as the RU. Specify a value in the range 265-65,535.
tot_link_act_lim
Total link activation limit (the maximum number of links that can be active at any time using this port).
inb_link_act_lim
Inbound link activation limit (the number of links reserved for inbound activation). The sum of inb_link_act_lim and out_link_act_lim must not exceed tot_link_act_lim; the difference between inb_link_act_lim and tot_link_act_lim defines the maximum number of links that can be activated outbound at any time.
out_link_act_lim
Outbound link activation limit (the number of links reserved for outbound activation). The sum of inb_link_act_lim and out_link_act_lim must not exceed tot_link_act_lim; the difference between out_link_act_lim and tot_link_act_lim defines the maximum number of links that can be activated inbound at any time.
act_xid_exchange_limit
Activation XID exchange limit. Specify a value in the range 1-65,535.
nonact_xid_exchange_limit
Nonactivation XID exchange limit. Specify a value in the range 1-65,535.
max_ifrm_rcvd
Maximum number of I-frames that can be received by the local link stations before an acknowledgment is sent. Specify a value in the range 1-127.
target_pacing_count
Indicates the desired pacing window size. Specify a value in the range 1-32,767.
max_send_btu_size
Maximum BTU size that can be sent from this port. This value is used to negotiate the maximum BTU size that a pair of link stations can use to communicate with each other. The value includes the length of the TH and RH (total 9 bytes), as well as the RU. Specify a value in the range 265-65,535.
ip_version
Specifies whether link stations on this port use IPv4 or IPv6 addresses. All link stations that use the port must use the same type of address. You cannot change this parameter if one or more link stations already use this port. Possible values:
IPV4
Link stations on this port use IPv4 addresses.
IPV6
Link stations on this port use IPv6 addresses.
implicit_cp_cp_sess_support
Specifies whether CP-CP sessions are allowed for implicit link stations using this port. Possible values are:
YES
CP-CP sessions are allowed for implicit link stations.
NO
CP-CP sessions are not allowed for implicit link stations.
implicit_limited_resource
Specifies whether implicit link stations off this port are defined as limited resources. Possible values are:
NO
Implicit links are not limited resources and are not automatically deactivated.
NO_SESSIONS
Implicit links are limited resources and are automatically deactivated when no active sessions are using them.
INACTIVITY
Implicit links are limited resources and are automatically deactivated when no active sessions are using them or when no data has flowed for the time period specified by the implicit_deact_timer parameter.
  • If no SSCP-PU session is active across the link, the node deactivates the link immediately.
  • If an SSCP-PU session is active but no traffic has flowed for the specified time period, the node sends REQDISCONT(normal) to the host. The host is then responsible for deactivating all LUs and the PU, at which time the local node will deactivate the link. However, the host may not deactivate LUs with active PLU-SLU sessions; in this case, the link remains active until all these sessions are deactivated (for example by the user logging out). This behavior can be changed by using options in the ptf_flags parameter of the define_node command.
implicit_deact_timer
Implicit limited resource link deactivation timer, in seconds.

If implicit_limited_resource is set to NO_SESSIONS, then the implicit link is automatically deactivated if no data flows on it for the time specified by this parameter and no sessions are using the link.

If implicit_limited_resource is set to INACTIVITY, an implicit link using this port is automatically deactivated if no data flows on it for the time specified by this parameter.

The minimum value is 5; values in the range 1-4 will be interpreted as 5. The value 0 (zero) indicates no timeout (the link is not deactivated, as though implicit_limited_resource were set to NO). This parameter is reserved if implicit_limited_resource is set to NO.

implicit_uplink_to_en
This parameter applies only if the local node is a Branch Network Node; it is reserved if the local node is any other type.

If the adjacent node is an end node, this parameter specifies whether implicit link stations off this port are uplink or downlink. This parameter is ignored if there are existing links to the same adjacent node, because in this case the existing links are used to determine the link type. Possible values are:

YES
Implicit links to an End Node are uplinks.
NO
Implicit links to an End Node are downlinks.
effect_cap through user_def_parm_3
Default TG characteristics used for implicit link stations using this port and as the default TG characteristics for defined link stations that do not have explicitly defined TG characteristics. The TG characteristics parameters are ignored if the LS is to a downstream PU.

For more information about these parameters, see define_ip_ls.

initially_active
Specifies whether this port is automatically started when the node is started. Possible values are:
YES
The port is automatically started when the node is started.
NO
The port is automatically started only if an LS that uses the port is defined as initially active; otherwise, it must be manually started.
implicit_ls_limit
Specifies the maximum number of implicit link stations which can be active on this port simultaneously, including dynamic links and links activated for Discovery. Specify a value in the range 1-65,534 or specify 0 (zero) to indicate no limit. A value of NO_IMPLICIT_LINKS indicates that no implicit links are allowed.
liveness_timeout through short_hold_mode
For more information about these parameters, see define_ip_ls. When the LS name is not initially known, the values specified on define_ip_port are used as defaults for processing incoming calls.
local_ip_interface
Identifier for the local network adapter card to be used for the IP link, if you have access to multiple IP networks. If you have access to only one IP network, there is no need to specify this identifier.

If you need to specify the interface, you can use any of the following.

  • An interface identifier (such as eth0 or en0).
  • An IPv4 dotted-decimal address (such as 193.1.11.100).
  • An IPv6 colon-hexadecimal address (such as 2001:0db8:0000:0000:0000:0000:1428:57ab or 2001:db8::1428:57ab).

To determine the interface identifier, run the command ipconfig - a on the server where the card is installed. This lists the interface identifiers and their associated IP addresses.