1. ENUM User Guide
  2. Feature Configurations
  3. MMI Managed Objects for ENUM Support

6.2 MMI Managed Objects for ENUM Support

MMI information associated with ENUM can be configured from a DSR NOAM or SOAM from Main Menu, and then MMI API Guide.

Once the MMI API Guide gets opened, use the application navigation to locate specific ENUM managed object information.

The following table lists the managed objects and operations supported for ENUM:

Managed Object Name Supported Actions
ENUM ACLs POST, DELETE
ENUM Options PUT
DNS Connection POST, DELETE
DNS Zone Config POST, DELETE
DNS Records POST, DELETE
DNS Server Options PUT

ENUM ACLs

The ENUM ACLs MO supports the following parameters:

Table 6-2 ENUM ACLs Parameters

Parameter Name Description
ipAddress IPv4 or IPv6 addresses which are to be allowed or blocked for ENUM feature. Valid entries are valid IPv6 and IPv4 addresses.
prefix Specifies number of bits in netmask. Allowed values are:
  • 1-31 for IPv4
  • 32,40,48,56,64 or 96 for IPv6
filter Specifies whether the configured IP is to be allowed or blocked. Blocked filter takes precedence over Allowed, if an IP falls in both ranges.

Example- Insert

Create a file with following content to set values of the parameters. File name could be anything, for example option name can be used as filename:
{
"filter": "BLOCKED",
"ipAddress": "10.75.219.180",
"prefix": "24"
}

Execute the following command on Active SOAM to insert the data:

/venum/enumacls/ -v POST –r <filename>.json
Execute the following command to display the content:
/venum/enumacls
{
"filter": "BLOCKED",
"ipAddress": "10.75.219.180",
"prefix": "24"
}

ENUM Options

The ENUM Options MO supports the following parameters:

Table 6-3 ENUM Options Parameters

Parameter Name Description
congestionNotification Congestion Notification Flag for response, valid values are Yes, No
congestionResCode RCODE values in ENUM error response message to be sent due to congestion on ENUM application.

Range [5,15]

Default: 5
maxDnDigits Max number of DN digits from an incoming ENUM query.

Range [8,15]

Default: 15
addRnContext Flag for RNCONTEXT parameter in ENUM TEL URI. Valid values are Yes, No. The default value is No.
rnContextCC Default country code for RN Context.
excludeSP Flag to indicate whether the SP entity Id shall be excluded in ENUN Tel and SIP URI. Valid values are Yes, No. The default value is No.

Note:

If the incoming DN is found in Individual/range DN table with an associated SP entity Id and ENUM option EXCLUDESP set to NO, then use that Configured Entity Id on UDR for response. If EXCLUSESP is set to yes, that SP/RN entity info is ignored and response is generated with ENUM data without RN.
enumTtl Time to live (in seconds) for ENUM response caching.
defaultNaptrSrvc Service parameter. This parameter specifies the supported ENUM services. This parameter is only valid for NAPTR response type.
defaultNSDomain This parameter specifies the domain name of the name server in the NS record. This parameter is only valid for the NS response type.
defaultNaptrFlag A containing flags to control aspects of the rewriting and interpretation of the fields in the record. This parameter is only valid for NAPTR response type.
defaultNaptrRegex NAPTR Regex Response. This parameter is only valid for NAPTR response type.

Example- Update

Create a file with following content to set values of the parameters. File name could be anything, for example option name can be used as filename:
{
            "addRnContext": "Yes",
            "congestionNotification": "No",
            "congestionResCode": 5,
            "defaultNSDomain": "abc2.com",
            "defaultNaptrFlag": "U",
            "defaultNaptrRegex": "!^.*$!sip:info@example.com!",
            "defaultNaptrSrvc": "SIP",
            "enumTtl": 3600,
            "excludeSP": "No",
            "maxDnDigits": 15,
            "rnContextCC": "AA"
        }

Execute the following command on Active SOAM to insert the data:

/venum/enumoptions -v PUT –r <filename>.json
Execute the following command to display the content:
/venum/enumoptions
{
            "addRnContext": "Yes",
            "congestionNotification": "No",
            "congestionResCode": 5,
            "defaultNSDomain": "abc2.com",
            "defaultNaptrFlag": "U",
            "defaultNaptrRegex": "!^.*$!sip:info@example.com!",
            "defaultNaptrSrvc": "SIP",
            "enumTtl": 3600,
            "excludeSP": "No",
            "maxDnDigits": 15,
            "rnContextCC": "AA"
        }

DNS Connection

The DNS Connection MO supports the following parameters:

Table 6-4 DNS Connection

Parameter Name Description
connName Name of the DNS Connection.

This is a mandatory value.
ipAddress IPv4 or IPv6 of networks to run DNS. Valid entries are valid IPv6 and IPv4 addresses.

This is a mandatory value.
udpPort Port to listen on.

The default value is 53.

Example - Insert

Create a file with following content to set values of the parameters. The Connection name must be unique across all DNS Connections sat the SOAM.

For example: 
{
            "connName": "Conn1",
            "ipAddress": "121.1.1.1",
            "udpPort": 54
}

Execute the following command on Active SOAM to insert the data:

/venum/dnsconnections/ -v POST –r <filename>.json
Execute the following command to display the content:
/venum/dnsconnections
{
            "connName": "Conn1",
            "ipAddress": "121.1.1.1",
            "udpPort": 54
}

DNS Zone Configs

The DNS Zone Configs MO supports the following parameters:

Table 6-5 DNS Zone Configs Parameters

Parameter Name Description
zoneName Name of the zone to be configured.
zoneType Specifies the zone type. It accepts the following options:

ENUM - ENUM Zone a type of forward zone.

Forward - Forwards all requests for information about this zone to other nameservers.

Master - Designates the nameserver as authoritative for this zone. A zone should be set as the master if the zone's configuration files reside on the system.

Slave - Designates the nameserver as a slave server for this zone. Master server is specified in masters directive.

static-stub: Zone data is statically configured through the server-address. Only the NS records are replicated.
ipAddress Specifies a valid IP address/addresses. If Zone Type is forward, this IP is treated as forwarder IP. IF zone Type is slave, this IP is the master IP. Multiple forward IPs can be configured seperated by semicolons.
port Port for forwarder IP(Forward Zone Type), or for master IP (Slave Zone Type).
forward Specifies the behavior of the forwarders directive. It accepts the following options: Only - When unable to query the nameservers listed in the forwarders directive, the server will not attempt to resolve the name on its own.
file Specifies the name of the file in the named working directory that contains the zone's configuration data.
notify Specifies whether to notify the secondary nameservers when a zone is updated. It accepts the following options: Yes - The server will notify all secondary nameservers. No - The server will not notify any secondary nameserver, Master - The server will notify primary server for the zone only.
soaDomainName Domain Name for the SOA Record. Only applicable to Master type of zone.
soaMailId Mail for the SOA Record. Only applicable to Master type of zone.
soaIpAddress A or AAAA record IP Address.
soaRefresh Time in seconds to refresh.
soaRetry Time in seconds to retry.
soaExpire Time in seconds to expire.
soaTtl Time to live in seconds for SOA record.

Example - Insert

Create a new Dns Zone Config to the VENUM configuration by setting the values to the parameters.

For example:
{
            "file": "test.db",
            "soaDomainName": "dns1.test.com",
            "soaExpire": 111,
            "soaIpAddress": "10.75.219.13",
            "soaMailId": "abc.test.com",
            "soaRefresh": 111,
            "soaRetry": 111,
            "soaTtl": 111,
            "zoneName": "test.com",
            "zoneType": "master"
        },
{
        "forward": "only",
        "ipAddress": "1.2.3.4;1.2.3.5",
        "port": 34,
        "zoneName": "testmul",
        "zoneType": "forward"
    },
{
            "ipAddress": "1.5.4.2;1.6.6.1",
            "port": 53,
            "zoneName": "stst",
            "zoneType": "staticStub"
}

Execute the following command on Active SOAM to insert the data:

/venum/dnszoneconfigs -v POST –r <filename>.json
Execute the following command to display the content:
/venum/dnszoneconfigs{
            "file": "test.db",
            "soaDomainName": "dns1.test.com",
            "soaExpire": 111,
            "soaIpAddress": "10.75.219.13",
            "soaMailId": "abc.test.com",
            "soaRefresh": 111,
            "soaRetry": 111,
            "soaTtl": 111,
            "zoneName": "test.com",
            "zoneType": "master"
        },
{
        "forward": "only",
        "ipAddress": "1.2.3.4;1.2.3.5",
        "port": 34,
        "zoneName": "testmul",
        "zoneType": "forward"
    },
{
            "ipAddress": "1.5.4.2;1.6.6.1",
            "port": 53,
            "zoneName": "stst",
            "zoneType": "staticStub"
}

DNS Records

The DNS Records MO supports the following parameters:

Table 6-6 DNS Records Parameters

Parameter Name Description
recordName Name of the DNS Record.
zoneName Name of the zone associated with the DNS Record.
recordType Indicates type of DNS Record. Possible values are A, AAAA, NAPTR, NS, CNAME, SRV, PTR
domainNameAddress Domain Name or address of the DNS Record.
ttl Time to live in seconds for the DNS record.
rdata Resolving Data like IP, Hostname or Regex.

Example - Insert

Create a new Dns Record to the VENUM configuration by setting the values to the parameters.

For example:
{
            "domainNameAddress": "spdomain",
            "rdata": "mailto:sip+9876543",
            "recordName": "test1",
            "recordType": "NAPTR",
            "ttl": 1,
            "zoneName": "sampleZone"
}

Execute the following command on Active SOAM to insert the data:

/venum/dnsrecords -v POST –r <filename>.json
Execute the following command to display the content:
/venum/dnsrecords{
            "domainNameAddress": "spdomain",
            "rdata": "mailto:sip+9876543",
            "recordName": "test1",
            "recordType": "NAPTR",
            "ttl": 1,
            "zoneName": "sampleZone"
}

DNS Server Options

The DNS Server Options MO supports the following parameters:

Table 6-7 DNS Server Options Parameters

Parameter Name Description
enableEmptyZone Controls whether or not empty zones are created.
maxCacheSize Specifies the maximum amount of memory to be used for server caches in MB. When the limit is reached, the server causes records to expire prematurely so that the limit is not exceeded. In a server with multiple views, the limit applies separately to the cache of each view. The default option is 32M.
maxCacheTtl Maximum time to live in seconds for cached responses.
recursion Specifies whether to act as a recursive server. Default is Yes.

Example- Update

Update the DNS Server Options by setting the values supplied to the parameters.

Note:

To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, and then PUT the options.
For example:
{
            "enableEmptyZone": "Yes",
            "maxCacheSize": "32",
            "maxCacheTtl": 604800,
            "recursion": "Yes"
}

Execute the following command on Active SOAM to insert the data:

/venum/dnsserveroptions -v PUT –r <filename>.json
Execute the following command to display the content:
/venum/dnsserveroptions{
            "enableEmptyZone": "Yes",
            "maxCacheSize": "32",
            "maxCacheTtl": 604800,
            "recursion": "Yes"
}