Class comm:Dns (CONCRETE)

Class ID:286
Encrypted: false - Exportable: true - Persistent: true
Privileges: [aaa, admin, ext-lan-config]
SNMP OID: .1.3.6.1.4.1.9.9.719.1.20.4

Specifies the DNS domain name of this UCS system.


Naming Rules
RN FORMAT: dns-svc

    [1] PREFIX=dns-svc


DN FORMAT: 

[0] sys/svc-ext/dns-svc

[1] org-[name]/comm-pol-[name]/dns-svc

                



Containers Hierarchies
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
org:Org
 
 ├
comm:SvcPolicy
 
 
 ├
comm:Dns
top:Root This class represents the root element in the object hierarchy. All managed objects in the system are descendants of the Root element.
 ├
top:System Provides general information about this system, such as the name, IP address and current time.
 
 ├
comm:SvcEp Service configuration for various services
 
 
 ├
comm:Dns


Contained Hierarchy
comm:Dns
 ├
comm:DnsProvider

Inheritance
naming:NamedObject
 ├
policy:Object
 
 ├
policy:Definition
 
 
 ├
comm:Definition
 
 
 
 ├
comm:Svc default port value is 0. All services that have assigned port override port value. 0 indicates that this service does not use a separate port
 
 
 
 
 ├
comm:Dns

Events
                



Faults
                



Fsms
                



Properties Summary
Defined in: comm:Dns
comm:Hostname
          string:Basic
domain  (comm:Dns:domain)
           The domain name used for host to IP address resolution when the name to be resolved does not include a domain part. Several Managed Objects include a host name property that needs to be resolved to an IP address. This includes NTP servers, SMTP server, SCP/FTP/TFTP/SFTP servers for import/export operations, etc. If the host name is specified as an IP address, UCS uses the IP address directly. If the host name is a fully qualified domain name, UCS uses a DNS server to resolve the IP address. If the host name is a host name without the domain part, UCS appends the domain name to resolve the IP address.
Defined in: comm:Svc
comm:AdminState
          scalar:Enum8
adminState  (comm:Svc:adminState)
           NO COMMENTS
comm:Port
          scalar:Uint32
operPort  (comm:Svc:operPort)
           NO COMMENTS
comm:Port
          scalar:Uint32
port  (comm:Svc:port)
           NO COMMENTS
comm:Protocol
          scalar:Enum8
proto  (comm:Svc:proto)
           need protocol for creating iptable rule
Defined in: comm:Definition
naming:Name
          string:Basic
name  (comm:Definition:name)
           Overrides:policy:Object:name | naming:NamedObject:name
           NO COMMENTS
Defined in: policy:Definition
naming:Descr
          string:Basic
descr  (policy:Definition:descr)
           NO COMMENTS
policy:InternalId
          scalar:Uint32
intId  (policy:Definition:intId)
           NO COMMENTS
scalar:Uint32 policyLevel  (policy:Definition:policyLevel)
           policyLevel is used internally by generic policy server.
policy:PolicyOwner
          scalar:Enum8
policyOwner  (policy:Definition:policyOwner)
           "local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Defined in: mo:TopProps
mo:ModificationChildAction
          scalar:Bitmask32
childAction  (mo:TopProps:childAction)
          
reference:Object dn  (mo:TopProps:dn)
           The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />
reference:RN rn  (mo:TopProps:rn)
           The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />
mo:InstSaclType
          scalar:Bitmask8
sacl  (mo:TopProps:sacl)
           The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
mo:ModificationStatus
          scalar:Bitmask32
status  (mo:TopProps:status)
           This property controls the life cycle of a managed object

Properties Detail

adminState

Type: comm:AdminState
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
enabled 1 NO COMMENTS
disabled 2 NO COMMENTS
DEFAULT enabled(1) NO COMMENTS

childAction

Type: mo:ModificationChildAction
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelChildAction
Property Validators:
Comments:
Constants
deleteAll 16384u NO COMMENTS
ignore 4096u NO COMMENTS
deleteNonPresent 8192u NO COMMENTS
DEFAULT 0 This type is used to

descr

Type: naming:Descr
Primitive Type: string:Basic
Like: naming:Described:descr
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
NO COMMENTS

dn

Type: reference:Object
Units: null
Encrypted: false
Access: implicit
Category: TopLevelDn
Property Validators:
Comments:
The Distinguished Name (dn) unambiguously identifies an object in the system.
The dn provides a fully qualified path from the top of the object tree, all the way to the object. It is built as a sequence of relative names separated by the "/" character.
For example:
< ... dn = "sys/chassis-5/blade-2/adaptor-1" />

domain

Type: comm:Hostname
Primitive Type: string:Basic
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "256"
        Allowed Chars:
            Regex: [a-zA-Z0-9\[\]!#$%()*+,-./:;@ _{|}˜?&]+
Comments:
The domain name used for host to IP address resolution when the name to be resolved does not include a domain part. Several Managed Objects include a host name property that needs to be resolved to an IP address. This includes NTP servers, SMTP server, SCP/FTP/TFTP/SFTP servers for import/export operations, etc. If the host name is specified as an IP address, UCS uses the IP address directly. If the host name is a fully qualified domain name, UCS uses a DNS server to resolve the IP address. If the host name is a host name without the domain part, UCS appends the domain name to resolve the IP address.

intId

Type: policy:InternalId
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
NO COMMENTS
Constants
none 0u NO COMMENTS
DEFAULT none(0u) NO COMMENTS

name

Type: naming:Name
Primitive Type: string:Basic
Overrides:policy:Object:name  |  naming:NamedObject:name
Units: null
Encrypted: false
Access: create
Category: TopLevelRegular
Property Validators:
    Range:  min: "0"  max: "16"
        Allowed Chars:
            Regex: [a-zA-Z0-9_.:-]+
Comments:
NO COMMENTS

operPort

Type: comm:Port
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)65535l
Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

policyLevel

Type: scalar:Uint32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
policyLevel is used internally by generic policy server.

policyOwner

Type: policy:PolicyOwner
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
Comments:
"local" denotes policy created by local policy client, "policy" denotes a policy created by remote policy server.
Constants
local 0 NO COMMENTS
policy 1 NO COMMENTS
pending-policy 2 NO COMMENTS
DEFAULT local(0) NO COMMENTS

port

Type: comm:Port
Primitive Type: scalar:Uint32
Units: null
Encrypted: false
Access: admin
Category: TopLevelRegular
Property Validators:
    Range:  min: (long)0l  max: (long)65535l
Comments:
NO COMMENTS
Constants
defaultValue 0u NO COMMENTS

proto

Type: comm:Protocol
Primitive Type: scalar:Enum8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRegular
Property Validators:
Comments:
need protocol for creating iptable rule
Constants
none 0 NO COMMENTS
tcp 1 NO COMMENTS
udp 2 NO COMMENTS
all 3 NO COMMENTS
DEFAULT none(0) NO COMMENTS

rn

Type: reference:RN
Units: null
Encrypted: false
Access: implicit
Category: TopLevelRn
Property Validators:
Comments:
The Relative Name (rn) uniquely identifies an object within a given context.
Note that a dn is comprised of a sequence of relative names. For example, the context "sys/chassis-1/blade-1/adaptor-1/host-eth-2" can be thought of as the following expression:
dn = <root object>/{rn}/{rn}/{rn}/{rn}/{rn}.
The rn can then be used to identify the object (for instance, "adaptor-1") within the context:
<... rn ="../" />

sacl

Type: mo:InstSaclType
Primitive Type: scalar:Bitmask8
Units: null
Encrypted: false
Access: implicit
Category: TopLevelSacl
Property Validators:
Comments:
The system acl property for each Managed Object. br/> This property is a 8 bit mask and supports the following values :-
a: del
b: mod
c: addchild
d: cascade

By default all Managed Objects have the following permissions
a: del
b: mod
c: addchild
This property is persisted in the db. If this property has a value none
it means, the user has read only permissions on this object.
Constants
none 0 NO COMMENTS
del 1 NO COMMENTS
mod 2 NO COMMENTS
addchild 4 NO COMMENTS
cascade 8 NO COMMENTS
DEFAULT 0 NO COMMENTS

status

Type: mo:ModificationStatus
Primitive Type: scalar:Bitmask32
Units: null
Encrypted: false
Access: implicit
Category: TopLevelStatus
Property Validators:
Comments:
This property controls the life cycle of a managed object
Constants
removed 16u In a setter method: specifies that an object should be removed.
In the return value of a setter method: indicates that an object has been removed.
created 2u In a setter method: specifies that an object should be created. An error is returned if the object already exists.
In the return value of a setter method: indicates that an object has been created.
modified 4u In a setter method: specifies that an object should be modified
In the return value of a setter method: indicates that an object has been modified.
deleted 8u In a setter method: specifies that an object should be deleted.
In the return value of a setter method: indicates that an object has been deleted.
DEFAULT 0 This type controls the life cycle of objects passed in the XML API.

When used in a setter method (such as configConfMo), the ModificationStatus specifies whether an object should be created, modified, deleted or removed.
In the return value of a setter method, the ModificationStatus indicates the actual operation that was performed. For example, the ModificationStatus is set to "created" if the object was created. The ModificationStatus is not set if the object was neither created, modified, deleted or removed.

When invoking a setter method, the ModificationStatus is optional:
If a setter method such as configConfMo is invoked and the ModificationStatus is not set, the system automatically determines if the object should be created or modified.