Get Network Settings

Get Network Settings
Get Complete Network Settings

Retrieves comprehensive network configuration for the HCX Manager appliance, including hostname, domain, IPv4 addresses, DNS settings, and HTTP proxy configuration.

Returns:

  • Hostname & Domain: System identification details
  • IPv4 Configuration: Interface, IP address, netmask, gateway
  • DNS Settings: IPv4/IPv6 DNS servers and search domain list
  • Proxy Settings: HTTP proxy server, port, credentials (if configured)
Request
URI
GET
https://{server}:9443/system/network
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Network settings retrieved successfully

Returns SystemNetworkGetResponse200 of type(s) application/json 
{
    "hostName": "string",
    "domainName": "string",
    "networkIPv4AddressDto": {
        "interfaceInfo": "string",
        "ipv4Address": "string",
        "ipv4NetMask": "string",
        "ipv4Gateway": "string"
    },
    "networkIPv6AddressDto": {
        "interfaceInfo": "string",
        "ipv6Address": "string",
        "ipv6PrefixLength": "string",
        "ipv6Gateway": "string"
    },
    "dns": {
        "ipv4Dns": [
            "string"
        ],
        "ipv6Dns": [
            "string"
        ],
        "domainList": "string"
    },
    "proxyDto": {
        "httpProxyServer": "string",
        "proxyPort": "string",
        "proxyUsername": "string",
        "proxyUserPassword": "string"
    }
}
string
hostName
Optional

hostName

string
domainName
Optional

domainName

object
networkIPv4AddressDto
Optional

networkIPv4AddressDto

object
networkIPv6AddressDto
Optional

networkIPv6AddressDto

object
dns
Optional

dns

object
proxyDto
Optional

proxyDto


500

Internal server error while retrieving network settings

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/system/network
On This Page
System Configuration Operations
GET
Get Nsp Configuration
Deprecated
POST
Create Nsp Configuration
Deprecated
PUT
Update Nsp Configuration
Deprecated
GET
Get Static Routes
PUT
Configure Static Route
GET
Get Network Settings
PUT
Configure Dns Settings
DELETE
Remove Dns Settings
GET
Get Time Settings
PUT
Configure Time Settings
DELETE
Remove Ntp Settings
PUT
Change Appliance Password
GET
Get Apache Proxy Configuration
Deprecated
POST
Configure Apache Proxy
Deprecated