nodesUpdateManagementPort
Update management port configurations for network nodes in Hyperfabric, including IP addresses, DNS settings, proxy configurations, and connection states.
Instructions
Update a specific management port.
To use this tool, pass the resource ID and the fields to update as arguments
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fabricId | Yes | The fabric id or name. | |
| nodeId | Yes | This is a read-only field. The unique identifier of the node to which this management port belongs to. | |
| id | Yes | This is a read-only field. The unique identifier of the management port. | |
| cloudUrls | No | A list of one or more Cloud URLs used by a node. | |
| configOrigin | No | ConfigOrigin is used by a management port to indicate if the configuration was provided by the cloud or the device. | CONFIG_ORIGIN_CLOUD |
| connectedState | No | ConnectedState is used by a management port to indicate if the port is successfully connected to the Hyperfabric service. It is distinct from the AdminState. | CONNECTED_STATE_NOT_CONNECTED |
| description | No | The description is a user-defined field to store notes about the management port. | |
| dnsAddresses | No | A list of one or more DNS IP addresses used by the node. | |
| enabled | No | The administrative state of the management port which indicates if the management port is enabled or disabled. | |
| ipv4Address | No | The IPv4 host address for the management port of the node. | |
| ipv4ConfigType | No | ConfigType is used by a management port to indicate if the IP configuration is static or DHCP. | CONFIG_TYPE_STATIC |
| ipv4Gateway | No | The IPv4 gateway address for the management port of the node. | |
| ipv6Address | No | The IPv6 host address for the management port of the node. | |
| ipv6ConfigType | No | ConfigType is used by a management port to indicate if the IP configuration is static or DHCP. | CONFIG_TYPE_STATIC |
| ipv6Gateway | No | The IPv6 gateway address for the management port of the node. | |
| loginPassword | No | The password to be used by the system user to login to the node. An empty password is treated as "use current password", and not as "no password". | |
| metadata | No | Metadata defines a map of attributes related to the lifecycle of the object. | |
| name | No | The name of the management port of the node (E.g. eth0) | |
| noProxy | No | A list of IP addresses or domain names that should not be proxied. | |
| portType | No | PortType defines an enumeration of categories of ports. | DATA_PORT |
| proxyAddress | No | The URL for a configured HTTPs proxy for the node. | |
| proxyCredentialsId | No | A unique identifier of a set of credentials for the proxy. | |
| proxyPassword | No | A password to be used to authenticate to the proxy. Once set, this attribute is not returned. | |
| proxyUsername | No | A username to be used to authenticate to the proxy. | |
| setProxyPassword | No | The flag to indicate that the proxy password should be cleared. |