Configuring the Commander
- Configuring Basic Commander Functions
- Configuring File Server Information
- (Optional) Configuring Network Topology Collection
- Configuring Information About Files to Be Downloaded
- Configuring an Activation Policy for Downloaded Files
- (Optional) Enabling Clients to Automatically Clear Storage Space
- (Optional) Enabling Automatic Configuration File Backup
Configuring Basic Commander Functions
Context
To implement EasyDeploy using the Commander, you must configure a device on a network as the Commander.
For unified device management, specify only one device as the Commander on a networking running EasyDeploy.
Procedure
- Run system-view
The system view is displayed.
- Run easy-operation commander ip-address ip-address [ udp-port udp-port ]
The Commander IP address is configured.
The specified IP address must exist on the network.
- Run easy-operation commander enable
The Commander function is enabled.
By default, the Commander function is disabled.
Configuring File Server Information
Context
File server information includes the IP address of the file server from which clients obtain files, user names, and passwords.
The files clients need to download are saved on the file server. After obtaining information about files to be downloaded, clients download specific files from the file server specified by the Commander based on the obtained file information.
Procedure
- Run system-view
The system view is displayed.
- Run easy-operation
The Easy-Operation view is displayed.
- Perform any of the following steps based on the file server type:
Run tftp-server ip-address
An IP address is configured for the TFTP server.
Run ftp-server ip-address [ username username [ password password ] ]
An IP address is configured for the FTP server, and a user name and password are configured.
Run sftp-server ip-address [ username username [ password password ] ]
An IP address is configured for the SFTP server, and a user name and password are configured.
If the file server is an SFTP or FTP server and has a user name and password configured, configure the user name and password on the Commander.
Only information about one file server can be configured. If you run this command multiple times, only the latest configuration takes effect.
Using an SFTP server is recommended. FTP and TFTP protocols are less secure than SFTP.
(Optional) Configuring Network Topology Collection
Context
Network topology collection is provided by the Commander using the Neighbor Discovery Protocol (NDP) and Network Topology Discovery Protocol (NTDP). When this function is enabled on the Commander to deploy zero touch devices, users do not need to manually collect such information as device's MAC address or ESN. After zero touch devices are powered on and started, the Commander automatically collects device information and assigns client IDs to devices to bind device information with devices. The Commander can collect network topology information and specify information of files to be downloaded based on the collected network topology information.
Procedure
- Enable NDP.
Run system-view
The system view is displayed.
Run ndp enable
NDP is enabled globally.
By default, NDP is enabled globally.
(Optional) Run ndp enable interface { interface-type interface-number [ to interface-type interface-number ] }&<1-10>
NDP is enabled on interfaces.
By default, NDP is enabled on an interface.
(Optional) Run ndp timer aging aging-time
An aging time is configured for NDP packets.
By default, the aging time of the NDP packets on the receiving switch is 180 seconds. The aging time of the NDP packets must be larger than the interval for sending NDP packets.
(Optional) Run ndp timer hello interval
The interval for sending NDP packets is configured.
By default, the interval for sending NDP packets is 60 seconds. The interval for sending NDP packets must be smaller than the aging time of the NDP packets.
(Optional) Run ndp trunk-member enable
Trunk member interface-based NDP is enabled.
By default, trunk member interface-based NDP is disabled.
If links are established between devices through trunk interfaces, the system discovers neighbors and displays NTDP topology information based on the trunk interfaces. To obtain link information about trunk member interfaces, run this command to enable trunk member interface-based NDP for the system to discover neighbors and query topology information about the trunk member interfaces from the NMS.
- Enable NTDP.
Run ntdp enable
NTDP is enabled globally.
By default, NTDP is enabled globally.
(Optional) Enable NTDP on an interface.
Run interface range { interface-type interface-number1 [ to interface-type interface-number2 ] } &<1-10>
The interface group view is displayed.
Run ntdp enable
NTDP is enabled on an interface.
By default, NTDP is enabled on an interface.
Run quit
Return to the system view.
(Optional) Run ntdp hop max-hop-value
The maximum number of hops for collecting topology information using NTDP is configured.
By default, the maximum number of hops for collecting topology information using NTDP is 8. When the maximum number of hops is set to a large value, large memory space is occupied on the topology collection device.
(Optional) Run ntdp timer hop-delay hop-delay-time
The delay for the first interface to forward NTDP topology request packets is configured.
By default, the delay for the first interface to forward NTDP topology request packets is 200 milliseconds.
(Optional) Run ntdp timer port-delay port-delay-time
The delay for the other interfaces to forward NTDP topology request packets is configured.
By default, the delay for other interfaces to forward NTDP topology request packets is 20 milliseconds.
Run ntdp timer interval
The interval for collecting topology information is configured.
By default, the interval for collecting topology information using NTDP is 0, which indicates that topology information is not periodically collected.
The Commander collects network topology information at an interval of 5 minutes; therefore, you are advised to set the interval for collecting topology information using NTDP to less than 5 minutes.
(Optional) Run ntdp explore in the user view
Topology information is manually collected.
You can run this command to collect network topology information at any time.
- Configure a cluster management VLAN.
Run system-view
The system view is displayed.
Run cluster enable
The cluster function is enabled.
By default, the cluster function is disabled.
Run cluster
The cluster view is displayed.
Run mngvlanid vlanid
A cluster management VLAN is configured.
By default, the cluster management VLAN is VLAN 1. However, VLAN 1 is not recommended as the cluster management VLAN. You are advised to change the cluster management VLAN to a different VLAN.
The cluster management VLAN must be the same as the VLAN to which the Commander's interfaces connected to clients.
- Configure Commander topology collection.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
Run topology enable
The Commander is configured to collect network topology information.
By default, the Commander cannot collect network topology information.
(Optional) Run topology save
The currently collected network topology information is saved.
(Optional) Run client auto-join enable
Clients are configured to automatically join the management domain of the Commander.
By default, clients do not automatically join the management domain of the Commander.
After a client automatically joins the management domain of the Commander, the Commander automatically learns client information and assigns the minimum ID not in use to the client. If the auto-join function is not enabled, the Commander does not assign IDs to clients, and you must run the client [ client-id ] { mac-address mac-address | esn esn } command to assign IDs to clients.
Example
Run the display easy-operation topology command to view network topology information collected by the Commander after clients are enabled to automatically join the management domain of the Commander.
<HUAWEI> display easy-operation topology <-->:normal device <??>:lost device Total topology node number: 3 ------------------------------------------------------------------------------ [HUAWEI: 4CB1-6C8F-0447](Commander) |-(GE0/0/8)<-->(GE0/0/38)[HUAWEI: 0200-2326-1007](Client 1) | |-(GE0/0/16)<-->(GE0/0/16)[HUAWEI: 0200-0000-0001](Client 2)
The command output shows that IDs are assigned to clients within the management domain of the Commander. If the auto-join function is not enabled, client IDs are not displayed.
Configuring Information About Files to Be Downloaded
Context
Information about files to be downloaded by clients includes the configuration file name, system software package name and version number, and patch file name. The network administrator can specify the type of files to be downloaded based on actual requirements.
When deploying zero touch devices, you can specify file information for each device or specify the same file information for a group of devices with the same attribute. The system preferentially matches the rule of a single client. If no matching rule is found, the system then matches the rule of a group. If still no matching rule is found or a rule is matched but no file information is specified in the rule, the system uses the default file information.
Procedure
Perform the following steps based on the network planning.
Configure file information for a client.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
In the following two situations, you need to manually bind device information with devices. In other situations, go to the next step.
Zero touch devices are deployed without using the network topology collection function:
Run client [ client-id ] { mac-address mac-address | esn esn }
A matching rule is defined for the client. The client can be uniquely identified by a MAC address or an ESN.
If client-id is not specified, the system assigns the smallest unused ID to the client.
Zero touch devices are deployed using the network topology collection function, but client auto-join is disabled:
Run client [ client-id ] mac-address mac-address
A matching rule based on the client's MAC address is defined.
Run client client-id { system-software file-name [ version ] | patch file-name | configuration-file file-name | web-file file-name | { custom-file file-name } &<1-3> }*
Information about files to be downloaded is configured.
Configure file information for a client group.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
Perform either of the following steps based on the group type:
Configure a matching rule for a built-in group.
Run group build-in device-type
A built-in group is created and the group view is displayed.
Configure a matching rule for a customized group.
Run group custom { mac-address | esn | ip-address | model | device-type } group-name
A customized group is created and the group view is displayed.
Run match { mac-address mac-address [ mac-mask | mac-mask-length ] | esn esn | ip-address ip-address [ ip-mask | ip-mask-length ] | model model | device-type device-type }
A matching rule is defined for the customized group.
- A maximum of 256 groups can be created and a maximum of 256 matching rules can be defined for the groups on the Commander. For groups created based on MAC addresses, IP addresses, or ESNs, multiple matching rules can be defined. For groups created based on device types and models, only one matching rule can be defined for each group.
- If multiple types of groups are configured, the clients match the groups in the following sequence: MAC address > ESN > IP address > device model > device type in the customized group > device type in the built-in group.
- If a client matches multiple groups of the same type, the groups are selected in alphabetical order of their names.
Perform the following steps to specify the files to be downloaded:
Run system-software file-name [ version ]
The system software package name and version number are specified.
Run patch file-name
The patch file name is specified.
Run configuration-file file-name
The configuration file name is specified.
Run web-file file-name
The web page file name is specified.
Run { custom-file file-name } &<1-3>
The user-defined file name is specified. A maximum of three user-defined files can be specified.
Configure default file information.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
Perform the following steps to specify the files to be downloaded:
Run system-software file-name [ version ]
The system software package name and version number are specified.
Run patch file-name
The patch file name is specified.
Run configuration-file file-name
The configuration file name is specified.
Run web-file file-name
The web page file name is specified.
Run { custom-file file-name } &<1-3>
The user-defined file name is specified. A maximum of three user-defined files can be specified.
Configuring an Activation Policy for Downloaded Files
Context
- Configuring a file activation time involves two values:
Specific time to activate files
Clients will activate files at a specified time.
Delay time before activating files
Clients activate downloaded files after a certain delay. The maximum delay can be 24 hours.
- Configuring a file activation mode involves choosing between two modes:
- Non-reset modeBy default, a client activates downloaded files without resetting. However, if a system software package (*.cc) is downloaded, the client resets to activate downloaded files regardless of whether the reset mode is configured. If no system software package is downloaded, the client activates the downloaded files as follows:
- The patch file is automatically activated.
- The configuration file is reversely compiled, and commands are saved in the client one by one. The client will use the configuration for next startup. If any command configuration fails during configuration recovery, the client resets to activate the configuration file.
- The web page file must be activated manually.
- Reset modeA client will use the downloaded system software package, patch file, and configuration file for the next startup. The web page file must be activated manually after the client resets.
If a hot patch needs to be downloaded, you can use the default file activation mode (non-reset). If a cold patch needs to be downloaded, set the file activation mode to reset.
If the client uses the non-reset mode to activate a configuration file but some commands in the configuration file cannot be restored, the client automatically uses the reset mode to activate the configuration file.
If some clients have downstream clients attached in cascading networking, it is recommended that you configure the global file activation delay time on the Commander. If an upstream client restarts or updates the configuration immediately after downloading required files, the downstream clients connected to this client are disconnected from the Commander or file server. As a result, the EasyDeploy process fails on the downstream clients. The file activation delay time avoids this problem.
Set an appropriate delay time based on the size of files to be downloaded, to ensure that all the downstream clients download the files within this delay time.
- Non-reset mode
Clients select an appropriate activation policy based on the downloaded file information.
- If you configure a group for clients when configuring the file information, the file activation mode and time configured in the group take effect for the matching clients. If no file activation mode or time is configured in the group, the global file activation mode and time configured on the Commander take effect. If no global file activation mode or time is configured on the Commander, the default file activation mode and time are used.
- If you specify a specific client when configuring the file information or retain the default file information, the global file activation mode and time configured on the Commander take effect. If no global file activation mode or time is configured on the Commander, the default file activation mode and time are used.
Procedure
Configure a file activation policy in the group view.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
Run group build-in device-type
The built-in group view is displayed.
Or run group custom { mac-address | esn | ip-address | model | device-type } group-name
The customized group view is displayed.
Run activate-file { reload | { in time | delay delay-time } } *
An activation policy is configured for the group.
Configure a global file activation policy.
Run system-view
The system view is displayed.
Run easy-operation
The Easy-Operation view is displayed.
Run activate-file { reload | { in time | delay delay-time } }*
A global activation policy is configured.
(Optional) Enabling Clients to Automatically Clear Storage Space
Context
If storage space on a client is insufficient, the client cannot download system software. If this function is enabled, the client automatically deletes non-startup files if the storage space is insufficient.
Startup system software, including the running system software and the system software specified for next startup, will not be deleted when a client clears storage space.
This function is invalid for some types of file servers. If the file server is a TFTP server, this function does not take effect because the TFTP server does not return file size to clients. If an FTP or SFTP server does not support the function of returning file size, this function does not take effect. When an S switch serves as an FTP or a TFTP file server, the switch does not support the function of returning file size.
(Optional) Enabling Automatic Configuration File Backup
Context
After automatic configuration file backup is enabled, the configuration file of a client is automatically backed up to the file server for use in a faulty device replacement scenario. After a faulty client is replaced by a new client, the new client needs to obtain the latest configuration file of the faulty client to minimize impact on service.
Procedure
- Run system-view
The system view is displayed.
- Run easy-operation
The Easy-Operation view is displayed.
- Run backup configuration interval interval [ duplicate ]
The interval and mode of automatic configuration file backup are configured.
By default, the configuration file is not backed up automatically.
- Configuring Basic Commander Functions
- Configuring File Server Information
- (Optional) Configuring Network Topology Collection
- Configuring Information About Files to Be Downloaded
- Configuring an Activation Policy for Downloaded Files
- (Optional) Enabling Clients to Automatically Clear Storage Space
- (Optional) Enabling Automatic Configuration File Backup