pem.registerSharedNode

This method is supported by Operations starting from version 5.0

This method allows registering Linux-based hardware nodes in Operations. Note that you cannot register a new node using this method if IP addresses used by the node for communication and shared IP addresses allocated to the node are configured as aliases on the network interface. A node can be added only by using the first address configured on the network interface.

The method has the following input parameters:

Name

Type

Short Description

host

string

BackNet IP Address or hostname of Hardware Node.

Important: The specified hostname should be resolved via DNS to the BackNet IP Address of the Hardware Node.

login

string

Login of the root or non-privileged user, which is used for Hardware Node registration.

[private_key]

struct

SSH Private Key for SSH Public-Key Authentication.

  • key

base64

SSH Private Key

  • password

string

Password of SSH Private Key. Don't specify this parameter, if SSH Private Key is not protected by password.

[password]

string

Password of the root or non-privileged user for Password-Based Authentication.

[resource_type_id]

int

ID of Resource Type, which is created on the basis of the Hardware nodes Resource Class. It is optional parameter. If the parameter is omitted, the Resource Type is automatically found by Operations.

[new_hostname]

string

Custom hostname for Hardware Node. It is optional parameter. If it is specified, the Hardware Node is registered with custom hostname and this hostname is displayed in Operations control panel.

[network_config]

struct

Network configuration of Hardware Node. It is optional parameter. If it is not specified, the Communication and Shared IP Addresses are automatically found by Operations.

  • communication_ip

string

This parameter defines the Hardware Node's IP Address, which is used as Communication IP Address.

  • shared_ip

string

This parameter defines the Hardware Node's IP Address, which is used as Shared IP Address.

[register_only_shared_ip]

boolean

This parameter is optional. It forbids registration of any other IP addresses on the node except Shared IP Address. By default it is False (if not specified explicitly).

Note: The private_key and password optional parameters are mutually exclusive. If SSH Public-Key Authentication is used, the private_key parameter should be specified. If Password-Based Authentication is used, the password parameter should be specified.

The method has the following output parameters:

Name

Type

Short Description

host_id

int

Host ID of the registered Hardware Node.