ip_domain

Initiate, change, erase, or print the data for a domain.

Format

• [-v] [-V] --reread
• [-v] [-V] -c --domain-name x [--ip-net s] [--server-ip-net [s]] [--codec-priority-list s] [--packetization-interval x] [--bandwidth x] [--video-limit x] [--emedir [s]] [--area-code [x]] [--location-id [x]] [--corporate-logon x]
• [-v] [-V] -e --domain-name x
• [-v] [-V] -i --domain-name x --ip-net s [--server-ip-net s] [--codec-priority-list s] [--packetization-interval x] [--bandwidth x] [--video-limit x] [--emedir s] [--area-code x] [--location-id x] [--corporate-logon x]
• [-v] [-V] -p [--domain-name x]
• [-v] [-V] -p [--ip-address x]

Function

The command is used for the following functionalities:

• To initiate a domain for Call Admission Control, a domain used for registration distribution and/or Emergency calls from a registered IP telephone.
• To change, remove, and print domain(s).
• The command can also be used to match a peer IP address to a peer domain, which might be needed to accept a peer certificate for that domain during TLS handshake. For more information, see EXAMPLES section below.

Note: When changing codecs, the default priority list is used as reference.

Parameters

• --area-code

  States the area code associated to the network domain. A regional code to a certain domain can be set. It can be used to prefix the dialed number before routing the call. Accepted argument length is 1 to 6 digits. In commands where this switch is optional the default value is an empty string.

  If used with the switch '--initiate', the switch requires an argument. If used with the switch '--change', the switch takes an optional argument and if no argument is given, the default value is used. The argument is single-valued.

• --bandwidth

  States the network bandwidth in bit/s. The argument must be scaled using k,M,G,T as suffix. (For this switch k means 1000.) If the parameter is omitted at initiation, unlimited bandwidth is assumed. If the value 0 (0k, 0M, 0G or 0T) is given, the result will be unlimited bandwidth.

  The switch requires an argument. The argument is single-valued.

  For more information, see the operational directions for Call Admission Control.

• -c, --change

  Change some settings. That is, reconfigure an item (or several items).

  The switch takes no arguments.

• --codec-priority-list
  States the codec priority list used in gateway calls from/to IP terminals and SIP trunks. Supported codes by gateways are as follows:

  G722	G.722 high quality, 64 kbit/s
  PCMA	G.711 A-law, 64 kbit/s
  PCMU	G.711 u-law, 64 kbit/s
  G729AB	G.729 Annex A, Annex B (silence suppression)
  G729A	G.729 Annex A (no annex B = no silence suppression), 8 kbit/s
  AMR	4.75 - 12.2 kbit/s
  AMR-WB	6.6 - 23.85 kbit/s
  Opus	6 - 510 kbit/s

  Default priority list: G722, AMR-WB, PCMA, PCMU,AMR, G729AB, G729A, Opus, G.722 is the prioritized codec. The codec list is case-insensitive.

  Example: change the codec priority list so it prioritizes in the following order: PCMU,PCMA,G.729A

  '--codec-priority-list G722, PCMU, PCMA, G729A'.

  Possible values are: 'AMR', 'AMR-WB', 'G722', 'G729A', 'G729AB', 'OPUS', 'PCMA', 'PCMU'.

  The switch requires an argument. The argument can be a comma-separated sequence.

• --corporate-logon

  Special handling of emergency calls from Corporate logged on (logged on from remote node) SIP phones (6800/6900 terminals) belonging to the network domain. When such a phone dials an emergency number (stated in the -match parameter in the sip_route command), a message will be displayed urging the user to logoff and dial an emergency number used in the location where the telephone is located.

  Allowed values are: '1', 't', 'true', 'y', 'yes', '0', 'f', 'false', 'n', 'no'.

  The default value of this optional parameter is no.

  The switch requires an argument. The argument is single-valued.

• --domain-name

  States an identification label that defines a realm of administrative autonomy, authority, or control. Accepted argument length is 1 to 253 characters.

  Data for Call Admission Control and Emergency call can be set for this domain.

  The switch requires an argument. The argument is single valued.

• --emedir

  Directory numbers for dial back for emergency calls. --emedir is associated with a virtual extensions used to receive a dial back call from an emergency center in response to an emergency call from an IP extension. Accepted argument length is 2 to 20 digits. In commands where this switch is optional, the default value is an empty string.

  If used with the switch '--initiate', the switch requires an argument. If used with the switch '--change', the switch takes an optional argument, and if no argument is given the default value is used. The argument can be a comma-separated sequence.

• -e, --erase

  Erase some settings; that is, deconfigure an item (or several items).

  The switch takes no arguments.

• -i, --initiate

  Initiate some settings; that is, make initial configuration of an item (or several items).

  The switch takes no arguments.

• --ip-address

  States an IP address. No port number allowed.

  The switch requires an argument. The argument is single-valued.

• --ip-net

  States an IP subnet as IP address (no port number allowed) plus the number of mask bits separated by a slash, /. Example: 203.168.25.0/24

  The switch requires an argument. The argument can be a comma-separated sequence.

• --location-id

  States the ‘location identity’, that is,. a building, room or radio cell reference, or similar information that can be useful for example in emergency calls. Accepted argument length is 1 to 100 characters.In commands where this switch is optional the default value is an empty string.

  If used with the switch '--initiate', the switch requires an argument. If used with the switch '--change', the switch takes an optional argument and if no argument is given the default value is used. The argument is single-valued.

• --packetization-interval

  States the packetization interval. This parameter is used to specify the preferred length of time in milliseconds represented by the media in a packet. See RFC3551 for more information regarding packetization interval.

  The default preferred value is 20 ms of audio per RTP packet for any supported codec.

  The switch requires an argument. The argument is single-valued.

• -p, --print

  Print all or some settings, that is, print the configuration of an item, several items, or all items.

  The switch takes no arguments.

• --reread

  Request to reread the configuration of an item (or several items).

  The switch takes no arguments.

• --server-ip-net

  States an IP subnet as IP address (no port number allowed) / number of mask bits. Example: 203.0.113.0/24.

  If two or more domains shall share the same server, this switch shall hold the address of the server.(server's IP address with mask 32, example: 203.0.113.0/32). In commands where this switch is optional, the default value is an empty string, that is,. no address. Used at IP extension initiation and registration distribution. See OPERATIONAL DIRECTIONS IP Extension for details how and when to use.

  If used with the switch '--initiate', the switch requires an argument. If used with the switch '--change', the switch takes an optional argument and if no argument is given, the default value is used. The argument can be a comma-separated sequence.

• -v, --verbose

  Turn on verbose output (that is, progress information) to standard error.

  The switch takes no arguments.

• -V, --verbose-to-syslog

  Turn on verbose logging to syslog (usually to /var/log/messages).

  The switch takes no arguments.

• --video-limit

  States allowed percentage of restricted bandwidth available for video. If the parameter is omitted at initiation, video is allowed to use 100% of the bandwidth.

  The switch requires an argument. The argument is single-valued.

Examples

• Initiate the domain with domain name head-office and the IPv4 subnet 203.0.113.0/25, bandwidth limitation 256 kb and at most 50% video.

  ip_domain -i --domain-name head-office --ip-net 203.0.113.0/25 --bandwidth 256k --video-limit 50

• Initiate the domain with domain name 'branch-office-2', and the IPv6 subnet 2001:0db8:85a3:0042:1000:8a2e:0370:0371/120, bandwidth limitation 1 Mb and at most 50% video

  ip_domain -i --domain-name branch-office-2 --ip-net 2001:0db8:85a3:0042:1000:8a2e:0370:0371/120 --bandwidth 1M --video-limit 50

• Initiate the domain with domain name branch-office-3 and subnet 2001:DB8:3007::/64.

  ip_domain -i --domain-name branch-office-3 --ip-net 2001:DB8:3007::/64

• Print the domains.

  ip_domain -p

• Print the domain with domain name head-office.

  ip_domain -p --domain-name head-office

• Print the domain for the extension with IP address 203.0.113.38

  ip_domain -p --ip-address 203.0.113.38

• Erase the domain with domain name head-office.

  ip_domain -e --domain-name head-office

• Match MBG's domain name to its IP address.

  For a certain setup with MBG, MX-ONE only knows the IP address (but not the domain name) of MBG while MBG's certificate contains the domain but not the IP address (like for Web server certificate).

  The ip_domain can be used to match MBG's IP address to the domain name used in MBG's certificate.This is needed in this case for MX-ONE to accept the domain retrieved from MBG's certificate during a TLS handshake initiated from MX-ONE (like when flow is not used).

  ip_domain -i --domain-name mbg.company.com --ip-net 203.0.113.38/32