pem.registerWindowsNode

This method is supported by Operations starting from version 5.2

This method allows to register a Windows-based host in Operations.

The method has the following input parameters:

Name

Type

Short Description

host

string

The BackNet IP Address or hostname of the host.

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

username

string

The user name of local administrator for the host.

password

string

The password of local administrator for the host.

[domain_credentials]

struct

The Windows Domain credentials for Windows Hosting Infrastructure.

  • name

string

The name of the Windows Domain in the FQDN format.

  • admin_user

string

The user name of domain administrator for the Windows Domain.

  • admin_password

string

The password of domain administrator for the Windows Domain.

[role]

string

The name of the server role, which is applied to the host during its registration in Operations. The list of the server roles and server role parameters is provided in the table below.

Note: In the current Operations version this parameter is mandatory.

[role_params]

array of struct

Parameters of the server role. The list of parameters may vary depending on the specified server role. The list of the server roles and server role parameters is provided in the table below.

Note: In the current Operations version this parameter is mandatory.

  • name

string

The name of a parameter.

  • value

string

The value of a parameter.

[resource_type_id]

int

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

[network_config]

struct

The network configuration of the host. It is optional parameter. If it is not specified, the Communication and Shared IP Addresses are automatically chosen by Operations.

  • communication_ip

string

This parameter defines the IP Address, which is used as the Communication IP Address.

  • shared_ip

string

This parameter defines the IP Address, which is used as the 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).

The method has the following output parameters:

Name

Type

Short Description

host_id

int

The ID of the registered host in Operations.

Note: In the current Operations version the 0 value is returned.

Important: The detailed description of the server roles and server role parameters is provided in CloudBlue Commerce Operations Windows Hosting Infrastructure Deployment Guide >> Automated Deployment of Windows Hosting Infrastructure section.

There are the following server roles and server role parameters:

Server Role Parameter Description
PDC – the first Active Directory Domain Controller (initial configuration) pdc.SafeModeAdminPassword Directory Services Restore Mode Administrator password.
pdc.DomainNetbiosName Domain NetBIOS name.
REG_PDC – the first Active Directory Domain Controller (registration in Operations) ADDomainController.active.directory.default_reseller.name Name of default reseller or provider. This server role parameter is optional. The Provider value is used by default.
ADDomainController.active.directory.hosting.ou Name of your Hosting Organization Unit (the root organization unit for all hosting infrastructure).
SDC – the second Active Directory Domain Controller sdc.SafeModeAdminPassword Directory Services Restore Mode Administrator password.
ADDomainController.active.directory.default_reseller.name Name of default reseller or provider. This server role parameter is optional. The Provider value is used by default.
ADDomainController.active.directory.hosting.ou Name of your Hosting Organization Unit (the root organization unit for all hosting infrastructure).
MPS – MPS Server sql.PathToMedia Path to the media containing the MS SQL Server 2005 distribution.
sql.SQLServicePassword Password for the MPSSQLService account.
mps_tool.PathToMedia Path to the media containing the HMC 4.5 distribution.
mps.PathToReplacement Path to the directory containing the HMC service providers for replacement (HMC 3.5 IIS Provider and HMC 3.5/4.0 File System Provider).
dep_iis.PathToW2k3Distro Path to the Windows 2003 Server R2 distribution. The folder must contain the i386 sub-folder.