Cisco Unity Express -- DNS Configuration REST PI Service Operation

From DocWiki

Main page: Cisco Unity Express -- REST PI Service Operations

Previous page: Cisco Unity Express -- Login Banner REST PI Service Operation

Next page: Cisco Unity Express -- System Information REST PI Service Operation

Search the Cisco Unity Express documentation on the DocWiki:

---

Contents 1 DNS Configuration 1.1 Classes 1.1.1 DNS 1.1.2 DNSServerList 1.1.3 DNSServer 1.2 Resources 1.3 DNS configuration examples 1.3.1 Update DNS settings 1.3.2 Read DNS settings 1.3.3 Remove a DNS Server

DNS Configuration

Classes

Figure 17: DNS Settings

DNS

Class Name	DNS
Extends From	ManagedBaseElement
Description	System DNS configuration settings
XML Namespace	http://dns.model.rest.aesop.cisco.com
Field Name	Type	Constraints	Comments
hostName	String		Hostname where CUE is located
domainName	String		Domain name in which CUE is located
dnsServers	DNSServerList		List of DNS servers to be used

DNSServerList

Class Name	DNSServerList
Extends From	ManagedBaseElement
Description	List of DNS Servers
XML Namespace	http://dns.model.rest.aesop.cisco.com
Field Name	Type	Constraints	Comments
dnsServer	DNSServer (collection)		List of DNS servers to be used

DNSServer

Class Name	DNSServer
Extends From	ManagedBaseElement
Description	A DNS Server
XML Namespace	http://dns.model.rest.aesop.cisco.com
Field Name	Type	Constraints	Comments
address	String		Address of the DNS server

Resources

Resource URI	Operation	Input	Return Value
/system/dns	GET (read DNS settings)		DNS
	PUT (update DNS settings)	DNS (including DNSServerList)
/system/dns/servers	GET (read list of DNS servers configured)		DNSServerList
	PUT (update the list of DNS servers)	DNSServerList
	POST (Add a DNS server to the list of configured DNS servers)	DNSServer
/system/dns/servers/{dnsServerAddress}	GET (Read DNSServer)	DNSServer
	DELETE (Remove a DNS server from the lust of DNS servers configured)

DNS configuration examples

Update DNS settings

• Data for the DNS settings is read from local file ./data/dns_data.xml.
• Changed atributes are dnsServers (DNS Server list) and hostName.
• Notice that DNSServer to be configured can be referenced either by resource URI or address.

$ cat data/dns_data.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dns>
    <dnsServers>
         <dnsServer>
              <address>5.6.7.8</address>
         </dnsServer>
    <dnsServer>
        <resourceURI>/system/dns/servers/1.2.3.4</resourceURI>
    </dnsServer>
    <dnsServer>
        <resourceURI>/system/dns/servers/1.2.3.5</resourceURI>
    </dnsServer>
    </dnsServers>
    <hostName>newhostname</hostName>
</dns>

$ curl -i -X PUT -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type: application/xml' -d  
@./data/dns_data.xml http://172.27.104.144/rest/system/dns 
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=B86ADA2D33F944576E8814824B42AAC6; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 09:44:34 GMT
Updated - /system/dns

Read DNS settings

$ curl -i -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28=' http://172.27.104.144/rest/system/dns 
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=A0333BDEA9895E0EC8B77D8D60EBFA53; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 09:44:42 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dns>
    <resourceURI>/system/dns</resourceURI>
    <dnsServers>
         <resourceURI>/system/dns/servers</resourceURI>
         <dnsServer>
              <resourceURI>/system/dns/servers/5.6.7.8</resourceURI>
              <address>5.6.7.8</address>
         </dnsServer>
         <dnsServer>
              <resourceURI>/system/dns/servers/1.2.3.4</resourceURI>
              <address>1.2.3.4</address>
         </dnsServer>
         <dnsServer>
              <resourceURI>/system/dns/servers/1.2.3.5</resourceURI>
              <address>1.2.3.5</address>
         </dnsServer>
    </dnsServers>
    <domainName>localdomain</domainName>
    <hostName>newhostname</hostName>
</dns>

Remove a DNS Server

Remove a DNS server (address 1.2.3.4) from DNS server list configured

$ curl -i -X DELETE -H 'Authorization: Basic Y2lzY286Y2lzY28=' http://172.27.104.144/rest/system  
/dns/servers/1.2.3.4
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=A50578616C1B282056169F1521CAEBCC; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 10:04:06 GMT
Removed  - /system/dns/servers/1.2.3.4