Add Or Update Edge Placement References

Populates placement references for edge node registered with identifier at NSX Manager. NSX Manager will then report current state of the VM and manage lifecycle operations like edit and delete of the specified edge VM. This internal API may be used to convert a manually deployed edge VM into an NSX lifecycle-managed edge VM. The edge VM must be reachable from NSX Manager. NSX Manager fetches live configuration from the edge and vCenter Server and reports the values in GET API for the following configuration. NSX Manager fetches the following settings from the edge - hostname, NTP servers, syslog servers, DNS servers, search domains and SSH. NSX Manager fetches the following configuration from vCenter Server - storage, networks, compute cluster, resource allocations and reservation for CPU and memory. NSX Manager saves fields that are not refreshed from sources external sources, from the request payload itself. Fields include login credentials, resource pool, static IP address, network interfaces with static port attachments and advanced configuration section. If these fields are configured on the edge and not specified in request payload, then the converted edge would have gaps as compared to an NSX Manager lifecycle-managed edge deployed with this configuration. Any gaps in configuration would feature when consequent lifecycle operations are performed.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/transport-nodes/{node-id}?action=addOrUpdatePlacementReferences

COPY

Path Parameters

string

node-id

Required

node-id

Request Body

TransportNodePlacementConfig of type(s) application/json

Required

Show optional properties

{
    "node_user_settings": {},
    "vm_deployment_config": {
        "placement_type": "string"
    },
    "vm_id": "string"
}

{
    "node_settings": {
        "advanced_configuration": [
            {
                "key": "string",
                "value": "string"
            }
        ],
        "allow_ssh_root_login": false,
        "dns_servers": [
            "string"
        ],
        "enable_ssh": false,
        "enable_upt_mode": false,
        "hostname": "string",
        "ntp_servers": [
            "string"
        ],
        "search_domains": [
            "string"
        ],
        "syslog_servers": [
            {
                "facility": [
                    "string"
                ],
                "log_level": "string",
                "message_id": [
                    "string"
                ],
                "name": "string",
                "port": "string",
                "protocol": "string",
                "server": "string",
                "structured_data": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            }
        ]
    },
    "node_user_settings": {
        "audit_password": "string",
        "audit_username": "string",
        "cli_password": "string",
        "cli_username": "string",
        "root_password": "string"
    },
    "vm_deployment_config": {
        "placement_type": "string"
    },
    "vm_id": "string"
}

object

node_settings

Optional

The settings are used during deployment and consequent update of an edge, unless indicated otherwise. These settings are editable for manually deployed edge nodes as well. If using DHCP, you must leave the following fields unset: search_domains, management_port_subnets, dns_servers and default_gateway_addresses. EdgeNodeSettings reports current values configured on the edge node. If the settings lag with actual state on the edge, these may be refreshed at NSX Manager using API POST api/v1/transport-nodes /<transport-node-id>?action=refresh_node_configuration&resource_type= EdgeNode

object

node_user_settings

Required

node_user_settings

object

vm_deployment_config

Required

vm_deployment_config

string

vm_id

Required

The edge node vm which is a transport node.

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200