Configuring NMS Resource Information

Function

This interface is used to configure NMS resource information.

It takes about 4 minutes to configure the interface.

Syntax

Operation type: POST

URL: https://device_ip/redfish/v1/NetManager

Request header:

X-Auth-Token: auth_value
Content-Type: header_type

Request message body:

{
    "ManagerType": manager_type,
    "NetIP": ip_address,
    "Port": port,
    "NetAccount": net_account,
    "NetPassword": net_password,
    "NodeId": node_id,
    "ServerName": server_name,
    "test": is_test
}

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Parameter Description	Value
ManagerType	Mandatory	NMS mode.	A string of characters. The values are as follows: Web: managed by the Atlas IES. FusionDirector: managed by FusionDirector.
NetIP	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Interconnection IP address.	Character string type. The value is an IPv4 address.
Port	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Peer port number.	The value is an integer ranging from 1 to 65535. Currently, only 443 is supported.
NetAccount	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Interconnection account.	The value is a string of 1 to 256 characters, consisting of lowercase letters (a to z), uppercase letters (A to Z), digits (0 to 9), hyphens (-), and underscores (_).
NetPassword	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Interconnection password.	The value is a string of 8 to 32 characters and must comply with the password complexity rules.
NodeId	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Node ID.	Character string. Currently, only the UUID format is supported. The length is 36 bytes. For example, e6a47e30-3a09-11ea-9218-a8494df5f123. NOTE: The value can contain digits (0-9), hyphens (-), and lowercase letters (a-f).
ServerName	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is optional when ManagerType is set to FusionDirector.	Server name.	FusionDirector mode: The value is a string of 0 to 64 bytes and can contain only lowercase letters (a to z), uppercase letters (A to Z), digits (0 to 9), hyphens (-), and dots (.). The value cannot be the domain name corresponding to 127.0.0.1 or ::1 in /etc/hosts, including but not limited to localhost, localhost.localdomain, localhost4, localhost4.localdomain4, localhost6, and localhost6.localdomain6.
test	Whether this parameter is mandatory depends on ManagerType. This parameter is optional when ManagerType is set to Web. This parameter is mandatory when ManagerType is set to FusionDirector.	Whether to test whether the NMS is available before the NMS takes effect.	The value is of the Boolean type: true: Test is required. false: Test is not required.

Usage Guidelines

If a port number has been configured for multiple times, the latest configuration takes effect.

Example

Request:

POST https://10.10.10.10/redfish/v1/NetManager

Request header:

X-Auth-Token: auth_value

Request message body:

Configure the web mode.
```
{
    "ManagerType":"Web"
}
```

Configure the FusionDirector mode.

{
    "ManagerType": "FusionDirector",
    "NetIP": "xx.xx.xx.xx",
    "Port": 443,
    "NetAccount": "EdgeAccount",
    "NetPassword": "****",
    "NodeId": "e6a47e30-3a09-11ea-9218-a8494df5f123",
    "ServerName": "",
    "test": true
}

Response:

The NMS mode is web.

{
    "@odata.context": "/redfish/v1/$metadata#NetManager",
    "@odata.id": "/redfish/v1/NetManager",
    "@odata.type": "#MindXEdgeNetManager.v1_0_0.MindXEdgeNetManager",
    "Id": "NetManager",
    "Name": "NetManager",
    "NetManager": "Web",
    "NetIP": "",
    "Port": "",
    "NetAccount": "",
    "ServerName": "",
    "ConnectStatus": "not_configured",
    "NodeID": {
        "@odata.id": "/redfish/v1/NetManager/NodeID"
    },
    "QueryFdCert": {
        "@odata.id": "/redfish/v1/NetManager/QueryFdCert"
    },
    "Actions": {
        "#ImportFdCert": {
            "target": "/redfish/v1/NetManager/ImportFdCert"
        },
        "#ImportFdCrl": {
            "target": "/redfish/v1/NetManager/ImportFdCrl"
        }
    }
}

The NMS mode is FusionDirector.

{
    "@odata.context": "/redfish/v1/$metadata#NetManager",
    "@odata.id": "/redfish/v1/NetManager",
    "@odata.type": "#MindXEdgeNetManager.v1_0_0.MindXEdgeNetManager",
    "Id": "NetManager",
    "Name": "NetManager",
    "NetManager": "FusionDirector",
    "NetIP": "xx.xx.xx.xx",
    "Port": "443",
    "NetAccount": "2102312NNUN0L6000008",
    "ServerName": "fd.fusiondirector.huawei.com",
    "ConnectStatus": "connected",
    "NodeID": {
        "@odata.id": "/redfish/v1/NetManager/NodeID"
    },
    "QueryFdCert": {
        "@odata.id": "/redfish/v1/NetManager/QueryFdCert"
    },
    "Actions": {
        "#ImportFdCert": {
            "target": "/redfish/v1/NetManager/ImportFdCert"
        },
        "#ImportFdCrl": {
            "target": "/redfish/v1/NetManager/ImportFdCrl"
        }
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of the current resource model. This is a fixed field of the northbound interface.
@odata.id	Character string	Path to access the current resource node. This is a fixed field of the northbound interface.
@odata.type	Character string	Current resource type. This is a fixed field of the northbound interface.
Id	Character string	ID of the current resource. This is a fixed field of the northbound interface.
Name	Character string	Name of the current resource. This is a fixed field of the northbound interface.
NetManager	Character string	NMS mode. The options are as follows: Web: managed by the Atlas IES. FusionDirector: managed by FusionDirector.
NetIP	Character string	Interconnection IP address. This parameter is valid only when FusionDirector is selected.
Port	Character string	Interconnection port number. This parameter is valid only when FusionDirector is selected.
NetAccount	Character string	Interconnection account. This parameter is valid only when FusionDirector is selected.
ServerName	Character string	Server name. This parameter is valid only when FusionDirector is selected.
ConnectStatus	Character string	Interconnection status. The options are as follows: not_configured: not configured connecting: connecting connected: connected error_configured: the configuration is incorrect.
NodeID	Object	Path to access a NodeID interface resource.
QueryFdCert	Object	Path to access a root certificate interface resource.
Actions	Object	Operations that can be performed.
Actions.#ImportFdCert	Object	Access path for importing the root certificate.
Actions.#ImportFdCrl	Object	Access path for importing the revocation list.

Parent topic: Network Management