ADD_NRG_LINK procedure

The ADD_NRG_LINK procedure adds a link to one or all of the Db2® Mirror Network Redundancy Groups (NRGs) on the source node. If the Network Redundancy Group does not exist, it will be created.

Authorization: The privileges held by the authorization ID of the statement must include *IOSYSCFG special authority. For the authority needed to use this procedure, see Authorization.

The schema is QSYS2.

nrg-name

A character or graphic string that contains the name of the NRG where the link is to be added. If the NRG does not exist, it will be created.

The valid NRG names and their primary uses are:

MIRROR_DATABASE

NRG for immediate replication of database-related objects and operations.

Object types: *DTAARA, *ENVVAR, *FILE, *JOBD, *JRN, *LIB, *PGM, *SQLPKG, *SQLUDT, *SQLXSR, *SRVPGM, and *SYSVAL.
SQL Data Definition Language operations.
Replication due to the restore of an object.

MIRROR_ENGINE

NRG used by the Db2 Mirror engine to manage the Db2 Mirror environment.

MIRROR_IFS

NRG used for accessing Integrated File System (IFS) data.

MIRROR_OTHER

NRG for immediate replication of security objects, security attributes, and non-database objects or operations.

Object types: *AUTL, *DTAQ, *FCNUSG, *JOBQ, *OUTQ, *SECATR, *SPLF, *USRIDX, *USRPRF, and *USRSPC.
Replication of objects due to Replication Criteria List changes.
Comparison of objects between the two nodes.

MIRROR_RESYNC

NRG for resynchronization of objects and data that were changed while replication was suspended.

The following special value is also allowed.

*MIRROR: This link will be added to all of the Db2 Mirror NRGs.

source-address

A character or graphic string that contains the local IP address for the link to add. Either an IPv4 or an IPv6 address can be specified.

target-address

A character or graphic string that contains the remote IP address for the link to add. Either an IPv4 or an IPv6 address can be specified.

link-priority

An integer value to set as the priority of the link. The range of priorities is from 1 to 16, where 1 is the highest priority. Priority values do not need to be unique.

increment-load-balance-link-count

A character or graphic string that indicate whether to increment the load balance link count.

NO: The load balance link count will remain at its current value.
YES: The load balance link count will be incremented by one. This is the default.

After being adjusted, the load balance link count must be a value from 1 to 16.

This parameter is optional.

line-description

A character or graphic string that contains the local system line description associated with this link. This parameter is required when source-address is an IPv6 link-local address and is used to identify a unique local interface. It is ignored for all other addresses.

virtual-lan-id

An integer value for the local virtual LAN identifier associated with this link. This parameter is required when source-address is an IPv6 link-local address and is used to identify a unique local interface. It is ignored for all other addresses.

rdma-type

A character or graphic string that indicates the type of RDMA protocol associated with this link. The link will not start if the RDMA type is set to different values on the local and remote nodes.

ROCE V1: RoCE version 1 is a non-encrypted and non-routable RDMA protocol. It transfers data using the Ethernet link layer protocol with Ethertype 0x8915 which allows communication between two hosts within the same Ethernet broadcast domain. Communicating host IP addresses must be in the same Ethernet broadcast domain and in the same subnet. This type of link will start only if non-encrypted RDMA is allowed in your environment. This is the default value.
ROCE V2: RoCE version 2 is a non-encrypted and routable RDMA protocol. It is an internet layer protocol which enables packets to be routed. Data is not encrypted and is transferred using the UDP protocol and UDP destination port number 4791. This type of link will start only if non-encrypted RDMA is allowed in your environment.
ENCRYPTED ROCE V2: Encrypted RoCE version 2 is an encrypted and routable RDMA protocol. RoCE version 2 with IPsec encryption is an internet layer protocol which enables packets to be routed securely by using IPsec protocols to provide data authentication, integrity, and confidentiality. A VPN connection must be configured for each RDMA link endpoint with data transforms (encryption protocols) supported by the adapter. A VPN connection must be available for the RDMA link to start. If the VPN connection is ended, the RDMA link is also ended. Data is encrypted using IPsec and transferred using the UDP protocol and UDP destination port number 4791.

Examples

Add a link to all Network Redundancy Groups on the source node. Set it to the highest priority and increase the load balance link count by 1.

CALL QSYS2.ADD_NRG_LINK(NRG_NAME => '*MIRROR',
                        SOURCE_ADDRESS => '9.5.94.95',
                        TARGET_ADDRESS => '9.5.94.100',
                        LINK_PRIORITY => 1,
                        INCREMENT_LOAD_BALANCE_LINK_COUNT => 'YES');

Add a link to all Network Redundancy Groups on the target node. Set it to the highest priority and increase the load balance link count by 1. The call to the procedure is done on the source node by invoking the procedure with a three-part qualified name. The first part of the name is the relational database name of the target node.
```
CALL REMOTESYS.QSYS2.ADD_NRG_LINK(NRG_NAME =>'*MIRROR',
                                  TARGET_ADDRESS => '9.5.94.95',
                                  SOURCE_ADDRESS => '9.5.94.100',
                                  LINK_PRIORITY => 1,
                                  INCREMENT_LOAD_BALANCE_LINK_COUNT => 'YES');
```

Add a standby link to all Network Redundancy Groups on the source node. Set it to the lowest priority and do not change the load balance link count.

CALL REMOTESYS.QSYS2.ADD_NRG_LINK(NRG_NAME =>'*MIRROR',
                                  TARGET_ADDRESS => '9.5.94.96',
                                  SOURCE_ADDRESS => '9.5.94.101',
                                  LINK_PRIORITY => 16,
                                  INCREMENT_LOAD_BALANCE_LINK_COUNT => 'NO');