Ddnsconfig

The Dynamic DNS (DDNS) Configuration holds the information used to establish the connection with the provider

Overview

assocGatewayId string
connectionStatus enum (FAILED | SUCCESS | UNKNOWN) read only  
enableDDNSConfig boolean
hostname string required   filterable   orderable  
password string required  
providerName enum (DYN_DNS | NO_IP) required   creation only  
username string required  

API Resource

/ddnsconfigs/id
delete get put

Parents

/nsgateways/id/ddnsconfigs
get post

Children

/ddnsconfigs/id/ddnsconfigbindings
get post

Members

This object has no members.

Attributes documentation

assocGatewayId string
Discussion

The associated parent NSGateway UUID to the Dynamic DNS Config

Charateristics

Format: free
Max length: 255
SDK attribute: assocGatewayId

connectionStatus enum read only  
Discussion

Dynamic DNS connection status represents the status of the provider connection.

Charateristics

Allowed values: FAILED, SUCCESS, UNKNOWN
Default value: UNKNOWN
SDK attribute: connectionStatus

enableDDNSConfig boolean
Discussion

User can enable/disable the DDNS config using this flag

Charateristics

Default value: true
SDK attribute: enableDDNSConfig

hostname string required   filterable   orderable  
Discussion

Fully Qualified Domain Name to be used for NSG Uplink

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: hostname

password string required  
Discussion

Dynamic DNS provider password

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: password

providerName enum required   creation only  
Discussion

Dynamic DNS Provider Name

Charateristics

Allowed values: DYN_DNS, NO_IP
Default value: DYN_DNS
SDK attribute: providerName

username string required  
Discussion

Dynamic DNS provider username

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: username