| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Change Network Server Description (CHGNWSD) command changes a network server description. Parameters that can be changed include server software parameters and network protocol descriptions.
More information about using this command can be found in the Blade and System x category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Restrictions:
| Top |
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| NWSD | Network server description | Communications name | Required, Key, Positional 1 |
| RSRCNAME | Resource name | Name, *SAME, *NONE, *AUTO | Optional |
| STGPTH | Storage path | Single values: *SAME Other values (up to 4 repetitions): Element list |
Optional |
| Element 1: Network server host adapter | Name, *NONE | ||
| Element 2: IP security rules | Element list | ||
| Element 1: Remote interface 1 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 2: Remote interface 2 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 3: Remote interface 3 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 4: Remote interface 4 rule | 1-16, *DFTSECRULE, *NONE | ||
| DFTSECRULE | Default IP security rule | 1-16, *SAME, *NONE | Optional |
| MLTPTHGRP | Multi-path group | Single values: *SAME, *NONE Other values (up to 4 repetitions): 1-4 |
Optional |
| DFTSTGPTH | Default storage path | 1-4, *SAME, *MLTPTHGRP | Optional |
| RMVMEDPTH | Removable media path | 1-4, *SAME | Optional |
| ACTTMR | Activation timer | 30-1800, *SAME | Optional |
| ONLINE | Online at IPL | *SAME, *YES, *NO | Optional |
| VRYWAIT | Vary on wait | 1-15, *SAME, *NOWAIT | Optional |
| SHUTDTIMO | Shutdown timeout | 2-45, *SAME, *TYPE | Optional |
| PARTITION | Partition | Character value, *SAME, *NONE | Optional |
| PTNNBR | Partition number | 1-65535, *SAME, *NONE | Optional |
| PRPDMNUSR | Propagate domain users | *SAME, *YES, *NO | Optional |
| CODEPAGE | Code page | Integer, *SAME, *LNGVER | Optional |
| MSGQ | Server message queue | Single values: *SAME, *JOBLOG, *NONE Other values: Qualified object name |
Optional |
| Qualifier 1: Server message queue | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| EVTLOG | Event log | Single values: *SAME, *ALL, *NONE Other values (up to 3 repetitions): *SYS, *SEC, *APP |
Optional |
| CMNMSGQ | Communications message queue | Single values: *SAME, *SYSOPR Other values: Qualified object name |
Optional |
| Qualifier 1: Communications message queue | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| CFGFILE | Configuration file | Single values: *SAME, *NONE Other values: Qualified object name |
Optional |
| Qualifier 1: Configuration file | Name | ||
| Qualifier 2: Library | Name, *LIBL, *CURLIB | ||
| POOL | Pool identifier | *SAME, *BASE, *SHRPOOL1, *SHRPOOL2, *SHRPOOL3, *SHRPOOL4, *SHRPOOL5, *SHRPOOL6, *SHRPOOL7, *SHRPOOL8, *SHRPOOL9, *SHRPOOL10, *SHRPOOL11, *SHRPOOL12, *SHRPOOL13, *SHRPOOL14, *SHRPOOL15, *SHRPOOL16, *SHRPOOL17, *SHRPOOL18, *SHRPOOL19, *SHRPOOL20, *SHRPOOL21, *SHRPOOL22, *SHRPOOL23, *SHRPOOL24, *SHRPOOL25, *SHRPOOL26, *SHRPOOL27, *SHRPOOL28, *SHRPOOL29, *SHRPOOL30, *SHRPOOL31, *SHRPOOL32, *SHRPOOL33, *SHRPOOL34, *SHRPOOL35, *SHRPOOL36, *SHRPOOL37, *SHRPOOL38, *SHRPOOL39, *SHRPOOL40, *SHRPOOL41, *SHRPOOL42, *SHRPOOL43, *SHRPOOL44, *SHRPOOL45, *SHRPOOL46, *SHRPOOL47, *SHRPOOL48, *SHRPOOL49, *SHRPOOL50, *SHRPOOL51, *SHRPOOL52, *SHRPOOL53, *SHRPOOL54, *SHRPOOL55, *SHRPOOL56, *SHRPOOL57, *SHRPOOL58, *SHRPOOL59, *SHRPOOL60 | Optional |
| TCPPORTCFG | TCP/IP port configuration | Single values: *SAME, *NONE Other values (up to 9 repetitions): Element list |
Optional |
| Element 1: Port | 1, 2, 3, 4, *INTERNAL, *VRTETHPTP, *VRTETH0, *VRTETH1, *VRTETH2, *VRTETH3, *VRTETH4, *VRTETH5, *VRTETH6, *VRTETH7, *VRTETH8, *VRTETH9 | ||
| Element 2: Internet address | Character value | ||
| Element 3: Subnet mask | Character value | ||
| Element 4: Maximum transmission unit | 68-65535, 1500 | ||
| Element 5: Gateway address | Character value, *NONE | ||
| TCPRTE | TCP/IP route configuration | Single values: *SAME, *NONE Other values (up to 24 repetitions): Element list |
Optional |
| Element 1: Route destination | Character value, *DFTROUTE | ||
| Element 2: Subnet mask | Character value, *NONE, *HOST | ||
| Element 3: Next hop | Character value | ||
| TCPHOSTNAM | TCP/IP local host name | Character value, *SAME, *NWSD | Optional |
| TCPDMNNAME | TCP/IP local domain name | Character value, *SAME, *SYS | Optional |
| TCPNAMSVR | TCP/IP name server system | Single values: *SAME, *SYS, *NONE Other values (up to 3 repetitions): Character value |
Optional |
| VRTETHPTH | Virtual Ethernet path | Single values: *SAME, *NONE Other values (up to 5 repetitions): Element list |
Optional |
| Element 1: Port number | *VRTETHPTP, *VRTETH0, *VRTETH1, *VRTETH2, *VRTETH3, *VRTETH4, *VRTETH5, *VRTETH6, *VRTETH7, *VRTETH8, *VRTETH9 | ||
| Element 2: Network server host adapter | Name, *DFTSTGPTH | ||
| Element 3: IP security rules | Element list | ||
| Element 1: Remote interface 1 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 2: Remote interface 2 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 3: Remote interface 3 rule | 1-16, *DFTSECRULE, *NONE | ||
| Element 4: Remote interface 4 rule | 1-16, *DFTSECRULE, *NONE | ||
| RSTDDEVRSC | Restricted device resources | Single values: *SAME, *NONE, *ALL Other values (up to 10 repetitions): Name, *ALLTAPE, *ALLOPT |
Optional |
| NWSCFG | Network server configuration | Single values: *SAME Other values: Element list |
Optional |
| Element 1: Remote system name | Name, *DFT | ||
| Element 2: Connection security name | Name, *DFT | ||
| VRTETHCTLP | Virtual Ethernet control port | 1024-65535, *SAME | Optional |
| SYNCTIME | Synchronize date and time | *SAME, *TYPE, *YES, *NO, *NONE | Optional |
| DSBUSRPRF | Disable user profiles | *SAME, *AUTO, *NO | Optional |
| IPLSRC | IPL source | *SAME, *NWSSTG, *PANEL, *STMF, A, B, D | Optional |
| IPLSTMF | IPL stream file | Path name, *SAME, *NONE | Optional |
| IPLPARM | IPL parameters | Character value, *SAME, *NONE | Optional |
| PWRCTL | Power control | *SAME, *YES, *NO | Optional |
| SRVOPT | Serviceability options | Character value, *SAME, *NONE | Optional |
| TEXT | Text 'description' | Character value, *SAME, *BLANK | Optional |
| Top |
Specifies the network server description to be changed.
This is a required parameter.
| Top |
Specifies the resource name that identifies the hardware that the description represents.
This parameter can be changed only while the network server description is varied off.
Notes:
Note: Use the Work with Hardware Resources (WRKHDWRSC) command with *CMN specified for the TYPE parameter to help determine the resource name.
| Top |
Specifies the storage paths the network server description can use.
This information consists of two parts including the Network server host adapter description and the IP security rules for this path.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
Single values
Other values (up to 4 repetitions)
Element 1: Network server host adapter
Note: The network server host adapter name must be unique for each value entered for the Storage path (STGPTH) parameter.
Element 2: IP security rules
Specifies the relative entry of an existing IP security rules (IPSECRULE) parameter, defined in the existing connection security network server configuration that will be used as the initial IP security setting between the hosting and remote system.
Element 1: Remote interface 1 rule
Element 2: Remote interface 2 rule
Element 3: Remote interface 3 rule
Element 4: Remote interface 4 rule
| Top |
Specifies the relative entry of the IP security rules (IPSECRULE) parameter, defined in Network server configuration (NWSCFG) of type connection security (*CNNSEC), that will be used for storage and virtual Ethernet connections that are configured to use the default security rule.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
| Top |
Specifies the storage paths defined in the Storage path (STGPTH) parameter to use for the multi-path group of storage paths.
Notes:
Single values
Other values (up to 4 repetitions)
| Top |
Specifies the relative default storage path defined in the Storage path (STGPTH) parameter or the multi-path group defined by the Multi-path group (MLTPTHGRP) parameter.
Notes:
| Top |
Specifies the relative storage path defined in the Storage path (STGPTH) parameter to use for removable media.
Notes:
| Top |
Specifies the amount of time (in seconds) the system will wait for the connection to be established to the remote server service processor and to power on the remote server.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
| Top |
Specifies whether this object is automatically varied on at initial program load (IPL).
Notes:
| Top |
Specifies the number of minutes to wait for the network server description to vary on synchronously or to vary on asynchronously.
| Top |
Specifies the shutdown timeout value in minutes. This is used to limit the amount of time that the integrated server operating system is allowed to shutdown before the network server description is varied off.
Note: The shutdown timeout value is 31 when Server connection specified *GUEST and Server operating system specified *OPSYS for the Network server type (TYPE) parameter. Shutdown timeout value is 15 for all other NWSDs.
Note: When Server connection specified *GUEST and Server operating system specified *OPSYS for the Network server type (TYPE) parameter the range is 31 to 45 minutes.
| Top |
Specifies the name of the logical partition to be used by this integrated server.
Note: When Server connection specified *GUEST for the Network server type (TYPE) parameter either the Partition (PARTITION) or Partition number (PTNNBR) parameter can be specified but both parameters cannot be specified. When Server connection specified *GUEST for the Network server type (TYPE) parameter and RSRCNAME is specified, the Partition (PARTITION) and Partition number (PTNNBR) parameter can be set to *NONE.
| Top |
Specifies the number of the logical partition to be used by this integrated server.
Notes:
| Top |
Specifies whether domain user enrollment should be allowed or not for this network server description.
Note: This parameter is only valid when Server connection specified *WINDOWSNT or Server operating system specified *WIN32 or *WIN64 for the Network server type (TYPE) parameter.
| Top |
Specifies the ASCII code page representing the character set to be used by this integrated server. Only certain code pages can be used for a given country or region code.
This parameter can be changed only while the network server description is varied off.
Note: When Server connection specified *GUEST value 437 will be used.
| Top |
Specifies the message queue to receive integrated server messages.
For details on the type of messages that are sent to this message queue, see the appropriate documentation that is associated with the type of integrated server.
Note: When a value other than *NONE is specified, all integrated server activity will be logged to either the monitor job log or the specified message queue. You should take the appropriate steps to secure this information on IBM i.
One method of restricting access to the integrated server information on IBM i is to create a message queue to contain the server activity. This message queue should be created with AUT(*EXCLUDE) and then any users that are to have access to the integrated server activity can be granted explicit authority to the message queue using the GRTOBJAUT command. Specify this message queue for this parameter.
Single values
Qualifier 1: Server message queue
Qualifier 2: Library
| Top |
Specifies whether or not messages from the event logs are received from the server.
Event log messages are placed in the message queue that is specified for the Server message queue (MSGQ) parameter. The MSGQ value cannot be *NONE if a value other than *NONE is specified for this parameter. See the MSGQ parameter description for more information.
Note: This parameter is only valid when Server connection specified *WINDOWSNT or Server operating system specified *WIN32 or *WIN64 for the Network server type (TYPE) parameter.
Single values
Other values (up to 3 repetitions)
Note: Each value can only be specified once.
| Top |
Specifies the name of a message queue to receive network server host adapter communications status messages.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
Single values
Qualifier 1: Communications message queue
Qualifier 2: Library
| Top |
Specifies the source file containing configuration data to be used in activating or further defining the integrated server.
Note: This parameter is not valid when Server connection specified *GUEST or Server operating system specified *ESX or *ESXE for the Network server type (TYPE) parameter.
Single values
Qualifier 1: Configuration file
Qualifier 2: Library
| Top |
Specifies the shared data storage pool this integrated server should use.
Note: This parameter is not valid when Server connection specified *IXSVR or *WINDOWSNT for the Network server type (TYPE) parameter.
| Top |
Specifies the TCP/IP configuration values that are specific to a port on the integrated server.
This information consists of five parts including the identification of the integrated server port, the internet address, the subnet mask, MTU and the default gateway assigned to the port.
Note: *NONE cannot be specified when Server connection specified *WINDOWSNT or Server operating system specified *WIN32, *WIN64, *LINUX32 or *LINUX64 for the Network server type (TYPE) parameter.
Single values
Other values (up to 9 repetitions)
Element 1: Port
Note: Each value can only be specified once.
Element 2: Internet address
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
An internet address that has a binary value of all ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the internet address is not valid.
Note: The internet address selected must be unique across all network server descriptions and the IBM i TCP/IP configuration.
Element 3: Subnet mask
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
Element 4: Maximum transmission unit
Element 5: Gateway address
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
| Top |
Specifies routes to remote destination systems or networks to the Transmission Control Protocol/Internet Protocol (TCP/IP) configuration for the integrated server.
A route specification has three elements: the route destination, the subnet mask, and the next hop internet address.
Two values uniquely define a route. They are the route destination field and the subnet mask. For *DFTROUTE values, the next hop element uniquely defines the route.
Notes:
Single values
Other values (up to 24 repetitions)
Element 1: Route destination
Specifies the remote network or host that is being added. The user must specify all four bytes that make up an internet address though some of the bytes may be equal to 0.
For example, a route to all the hosts on the 9.5.11 subnet is identified by entering 9.5.11.0 for the route destination. Used in combination with a subnet mask, the route destination will identify a route to a network or system.
Note: Any combination thereof means that you may specify a route, such as 9.5.0.0 to the hosts on the 9.5 subnet even though all 9.5.x.x addresses are class A network addresses.
Exceptions:
Element 2: Subnet mask
A subnet mask value must be specified if *DFTROUTE or a route destination is entered for the route destination element. Subnet mask specifies a bit mask that identifies to TCP/IP which bits of the value specified for the route destination compose the network and subnet portions of the internet address. The subnet is identified by combining the route destination internet address and the subnet mask.
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
For example, a destination route's internet address value of 129.35.11.0 is a Class B subnet. The network ID part of its address is 129.35. The upper 2 bytes must designate 255 in the subnet mask, for example, the subnet mask must appear like 255.255.x.x, where x is determined by the user. The portion of the subnet mask which is associated with the network portion of a particular class of address must equal 255.
Element 3: Next hop
The next hop value specifies the internet address of the next system (gateway) on the route. A route cannot be added unless the internet address specified by the next hop element is directly reachable through a network associated with one of the integrated server ports.
See the Fastpath for TCP/IP book for general information about internet addresses.
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
The host ID portion and the network ID portion of the internet address may not be all 0 bits or all 1 bits. An internet address that has all binary ones or all binary zeros for the network ID portion or the host ID portion of the internet address is not valid.
| Top |
Specifies the short form of the host name associated with the integrated server.
Notes:
The host name can be a text string having 1 through 63 characters.
The following characters are allowed in host names:
| Top |
Specifies the local domain name associated with the integrated server.
Notes:
A domain name can be a text string having 1 to 255 characters. Domain names consist of one or more labels separated by periods. Each label can contain up to 63 characters. The following characters are allowed in domain names:
Uppercase and lowercase characters are allowed, but no significance attached to the case. The case is maintained as entered. The first and last character of the host name must be an alphabetic character or a digit.
| Top |
Specifies the internet address of the name server system that is used by the integrated server.
Notes:
Single values
Other values (up to 3 repetitions)
The value is specified in the form nnn.nnn.nnn.nnn , where nnn is a decimal number ranging from 0 through 255.
| Top |
Specifies the virtual Ethernet paths the Ethernet line descriptions can use.
This information consists of three parts including the virtual Ethernet port, the Network server host adapter description and the IP security rules for this path.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
Single values
Note: This value is only valid when Server operating system specified *ESX or *ESXE for the Network server type (TYPE) parameter.
Other values (up to 5 repetitions)
Element 1: Port number
Note: Each value can only be specified once.
Element 2: Network server host adapter
Note: The network server host adapter name does not need to be unique for each value entered for the Virtual Ethernet path (VRTETHPTH) parameter.
Note: *MLTPTHGRP cannot be specified for the Default storage path (DFTSTGPTH) parameter when *DFTSTGPTH is used.
Element 3: IP security rules
Specifies the relative entry of an existing IP security rules (IPSECRULE) parameter, defined in the existing connection security network server configuration that will be used as the initial IP security setting between the hosting and remote system.
Element 1: Remote interface 1 rule
Element 2: Remote interface 2 rule
Element 3: Remote interface 3 rule
Element 4: Remote interface 4 rule
| Top |
Specifies the tape and optical device resource names that are restricted and cannot be used by the integrated server.
The resource is used when the integrated server is active and a request is issued from a client that is running an application. The device resource cannot be used by the client application and IBM i based application at the same time. If the device resource is intended to be used by an application, it will need to be available when the application is ready to use it.
Notes:
Single values
Other values (up to 10 repetitions)
Note: Each value can only be specified once.
| Top |
Specifies the network server configuration descriptions (NWSCFG) to use with this NWSD.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
Single values
Element 1: Remote system name
Element 2: Connection security name
| Top |
Specifies the TCP port to use for virtual Ethernet control.
This port listens through the local area network (LAN) interface configured for any network server host adapter (NWSH) device associated with the network server description (NWSD) object on the Virtual Ethernet path (VRTETHPTH) parameter.
Note: This parameter is only valid when Server connection specified *ISCSI for the Network server type (TYPE) parameter.
| Top |
Specifies whether IBM i should synchronize the integrated server date and time with IBM i date and time.
The QTIMZON system value must be set to the correct value for time synchronization to work correctly.
Note: This parameter is not valid when Server connection specified *GUEST for the Network server type (TYPE) parameter.
If Server connection specified *IXSVR, *ISCSI or *WINDOWSNT for the Network server type (TYPE) parameter, synchronization will be done as if SYNCTIME(*YES) was specified.
If Server operating system specified *ESX or *ESXE for the for the Network server type (TYPE) parameter, synchronization will be done as if SYNCTIME(*NONE) was specified.
The following occurs when Server connection specified *IXSVR or *ISCSI for the Network server type (TYPE) parameter:
| Top |
Specifies whether to disable the integrated servers user profiles if the corresponding IBM i user profiles are disabled.
Note: This parameter is only valid when Server connection specified *WINDOWSNT or Server operating system specified *WIN32 or *WIN64 for the Network server type (TYPE) parameter.
| Top |
Specifies the source of the load image that the partition is started from.
Note: This parameter is only valid when Server connection specified *GUEST for the Network server type (TYPE) parameter.
Note: This value is not valid when Server operating system specified *OPSYS for the Network server type (TYPE) parameter.
| Top |
Specifies the path of the stream file containing the image that the partition should be loaded from.
Note: This parameter is only valid when Server connection specified *GUEST for the Network server type (TYPE) parameter, and *STMF is specified for the IPL source (IPLSRC) parameter.
| Top |
Specifies a string of characters that will be passed to the load image at IPL time. It consists of commands or configuration information for the guest operating system.
Note: This parameter is only valid when Server connection specified *GUEST for the Network server type (TYPE) parameter.
Note: *NONE is only valid value when Server operating system specified *OPSYS for the Network server type (TYPE) parameter.
| Top |
Specifies whether the integrated server partition will be powered down when the network server description is varied offline or powered up when the network server description is varied online.
Note: This parameter is only valid when Server connection specified *GUEST for the Network server type (TYPE) parameter.
| Top |
Specifies serviceability options. This parameter allows serviceability options to be provided and is intended to be used under the direction of a service provider.
| Top |
Specifies the text that briefly describes the network server description.
| Top |
Example 1: Changing the TCP/IP Route Configuration
CHGNWSD NWSD(REMODEL2) TCPRTE((*DFTROUTE *NONE '9.5.5.1'))
This command changes a network server description named REMODEL2. The TCP/IP default route next hop address is changed to 9.5.5.1.
Example 2: Changing the Restricted Device Resources
CHGNWSD NWSD(WNTSVR4) RSTDDEVRSC(OPT02 *ALLTAPE)
This command changes a network server description named WNTSVR4. Device resource OPT02 and all tape resources (*ALLTAPE) are changed to have their access restricted from the network server description.
Example 3: Changing the Storage Path, Multi-path Group, Network Server Configuration and Shutdown TCP Port
CHGNWSD NWSD(WINISCSI)
STGPTH((NWSH3
(*DFTSECRULE *DFTSECRULE *DFTSECRULE *DFTSECRULE))
(NWSH4
(*DFTSECRULE *DFTSECRULE *DFTSECRULE *DFTSECRULE)))
MLTPTHGRP(1 2)
NWSCFG(YOURREMOTE QCNNSEC)
VRTETHCTLP(8950)
This command changes a network server description named WINISCSI. Storage paths one and two are changed to use network server host adapters NWSH3 and NWSH4. Multi-path group was changed to use storage paths 1 and 2. Network server configuration was changed to use YOURREMOTE for Remote system name and QCNNSEC for Connection security name. Virtual Ethernet control port was changed to 8950.
Example 4: Changing the Pool Identifier and Disable User Profiles
CHGNWSD NWSD(WINISCSI) POOL(*SHRPOOL55) DSBUSRPRF(*NO)
This command changes a network server description named WINISCSI. Shared storage pool 55 will be used and Disable of user profiles will not be done.
| Top |
| Top |