Context
The context of mag-virtual-machine-pool within the schema tree is shown. Italicised links are to other pages.
node-type choice mag deployment-config:mag-virtual-machine-pool (in mag-vmpool-config.yaml) deployment-id site-id node-type-suffix cassandra-contact-points list management.ipv4 signaling.ipv4 xcap-domains list additional-rhino-jvm-options list name value rhino-auth list username password role rem-auth list username real-name password role virtual-machines list vm-id diameter-zh-origin-host scheduled-sbb-cleanups scheduling-rule choice single-schedule frequency choice daily weekly day-of-week monthly day-of-month time-of-day multiple-schedule frequency-list choice weekly weekly list day-of-week time-of-day monthly monthly list time-of-day day-of-month rhino-node-id scheduled-rhino-restarts scheduling-rule choice single-schedule frequency choice daily weekly day-of-week monthly day-of-month time-of-day multiple-schedule frequency-list choice weekly weekly list day-of-week time-of-day monthly monthly list time-of-day day-of-month
The Management and Authentication Gateway (MAG) virtual machine pool.
This node and its descendants are configured in mag-vmpool-config.yaml.
deployment-id
The deployment identifier. Used to form a unique VM identifier within the VM host.
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type deployment-id-type
- Description
-
Deployment identifier type. May only contain upper and lower case letters 'a' through 'z', the digits '0' through '9' and hyphens. Must be between 1 and 20 characters in length, inclusive.
- Value
-
a string with length 0 or more matching
[a-zA-Z0-9-]{1,20}
site-id
Site ID for the site that this VM pool is a part of.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type site-id-type
- Description
-
Site identifier type. Must be the letters DC followed by one or more digits 0-9.
- Value
-
a string with length 0 or more matching
DC[0-9]+
node-type-suffix
Suffix to add to the node type when deriving the group identifier. Should normally be left blank.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type node-type-suffix-type
- Description
-
Node type suffix type. May only contain upper and lower case letters 'a' through 'z' and the digits '0' through '9'. May be empty.
- Value
-
a string with length 0 or more matching
[a-zA-Z0-9]* - Default value
-
''
cassandra-contact-points list
Explicit list of Cassandra contact points. This should only be specified for testing or special use cases. When left unspecified, the Cassandra contact points will be automatically determined from the TSN VM pool IP addresses.
List Structure
management.ipv4 ipv4-address-no-zone signaling.ipv4 ipv4-address-no-zone
The keys are management.ipv4 and signaling.ipv4.
management.ipv4
The IPv4 address of the management interface.
This node is mandatory.
Type ipv4-address-no-zone
- Description
-
An IPv4 address without a zone index.
See RFC 6991 for full details.
- Value
-
a string with length 0 or more matching
[0-9\.]*
signaling.ipv4
The IPv4 address of the signaling interface.
This node is mandatory.
Type ipv4-address-no-zone
- Description
-
An IPv4 address without a zone index.
See RFC 6991 for full details.
- Value
-
a string with length 0 or more matching
[0-9\.]*
xcap-domains list
The list of domains that the XCAP server will accept requests for.
Requests received by the XCAP server with a request URI containing a
domain not in this list will be rejected with a 404 Not Found
error response.
Each domain must start with the string 'xcap'.
The domains that the BSF server will accept requests for
are derived from these XCAP domains,
by replacing the initial 'xcap' string with 'bsf'.
Requests received by the BSF server with a request URI containing a
domain not in this list (after replacement of 'xcap' with 'bsf')
will be rejected with a 404 Not Found error response.
|
|
Metaswitch support should be contacted for advice on how changes to this value can be made to take effect. |
Must contain at least 1 element.
Type List of domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
Internet domain names are only loosely specified. Section 3.5 of RFC 1034 recommends a syntax (modified in Section 2.1 of RFC 1123). The pattern above is intended to allow for current practice in domain name use, and some possible future expansion. It is designed to hold various types of domain names, including names used for A or AAAA records (host names) and other records, such as SRV records. Note that Internet host names have a stricter syntax (described in RFC 952) than the DNS recommendations in RFCs 1034 and 1123, and that systems that want to store host names in schema nodes using the domain-name type are recommended to adhere to this stricter standard to ensure interoperability.
The encoding of DNS names in the DNS protocol is limited to 255 characters. Since the encoding consists of labels prefixed by a length bytes and there is a trailing NULL byte, only 253 characters can appear in the textual dotted notation.
The description clause of schema nodes using the domain-name type MUST describe when and how these names are resolved to IP addresses. Note that the resolution of a domain-name value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence can either be defined explicitly or may depend on the configuration of the resolver.
Domain-name values use the US-ASCII encoding. Their canonical format uses lowercase US-ASCII characters. Internationalized domain names MUST be A-labels as per RFC 5890.
- Reference
-
RFC 952: DoD Internet Host Table Specification
RFC 1034: Domain Names - Concepts and Facilities
RFC 1123: Requirements for Internet Hosts — Application
and Support
RFC 2782: A DNS RR for specifying the location of services
(DNS SRV)
RFC 5890: Internationalized Domain Names in Applications
(IDNA): Definitions and Document Framework
- Values
-
a string with length 1 to 253 matching
xcap.*
additional-rhino-jvm-options list
Additional JVM options to use when running Rhino. Should normally be left blank.
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
name
Name of the JVM option. Do not include '-D'.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type string
- Value
-
a string
value
Value for the JVM option.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string
rhino-auth list
List of Rhino users and their plain text passwords.
Must contain at least 1 element.
username
The user’s username. Must consist of between 3 and 16 alphanumeric characters.
Type string
- Value
-
a string with length 3 to 16 matching
[a-zA-Z0-9]+
password
The user’s password. Will be automatically encrypted at deployment using the deployment’s 'secret-private-key'.
Type secret
- Description
-
A secret, which will be automatically encrypted using the secrets-private-key configured in the Site Definition File (SDF).
- Value
-
a string with length 8 or more matching
[a-zA-Z0-9_@!$%^/.=-]+
role
The user’s role.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Administrator role. Can make changes to Rhino configuration. |
|
Read-only role. Cannot make changes to Rhino configuration. |
- Default value
-
'view'
username
The user’s username. Must consist of between 3 and 16 alphanumeric characters.
Type string
- Value
-
a string with length 3 to 16 matching
[a-zA-Z0-9]+
password
The user’s password. Will be automatically encrypted at deployment using the deployment’s 'secret-private-key'.
Type secret
- Description
-
A secret, which will be automatically encrypted using the secrets-private-key configured in the Site Definition File (SDF).
- Value
-
a string with length 8 or more matching
[a-zA-Z0-9_@!$%^/.=-]+
role
The user’s role.
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Administrator role. Can make changes to REM configuration. Also has access to the HSS Subscriber Provisioning REST API. |
|
Read-only role. Cannot make changes to REM configuration. Note: Rhino write permissions are controlled by the Rhino credentials used to connect to Rhino, NOT the REM credentials. |
- Default value
-
'em-user'
virtual-machines list
Configured virtual machines.
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
List Structure
vm-id string diameter-zh-origin-host domain-name scheduled-sbb-cleanups scheduling-rule choice single-schedule frequency choice daily weekly day-of-week enumeration monthly day-of-month uint8 time-of-day string multiple-schedule frequency-list choice weekly weekly list day-of-week enumeration time-of-day string monthly monthly list time-of-day string day-of-month uint8 rhino-node-id rhino-node-id-type scheduled-rhino-restarts scheduling-rule choice single-schedule frequency choice daily weekly day-of-week enumeration monthly day-of-month uint8 time-of-day string multiple-schedule frequency-list choice weekly weekly list day-of-week enumeration time-of-day string monthly monthly list time-of-day string day-of-month uint8
The key is vm-id.
The values of diameter-zh-origin-host must be unique.
The values of rhino-node-id must be unique.
vm-id
The unique virtual machine identifier.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string
diameter-zh-origin-host
The origin host to use when sending Diameter Zh requests from this node to the HSS.
|
|
A restart is required for changes to this value to take effect. |
This node is mandatory.
Type domain-name
- Description
-
The domain-name type represents a DNS domain name. The name SHOULD be fully qualified whenever possible.
See RFC 6991 for full details.
- Value
-
a string with length 1 to 253 matching
((([a-zA-Z0-9_]([a-zA-Z0-9\-]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.
scheduled-sbb-cleanups
Cleanup leftover SBBs and activities on specified schedules. If omitted, SBB cleanups will be scheduled for every day at 02:00.
- When present
-
This container is optional, but has mandatory descendants.
scheduling-rule choice
Whether the scheduled task runs once or multiple times per interval.
A Choice between one of the following:
frequency choice
Frequency options for running a scheduled task.
Note: running a scheduled task in the single-entry format is deprecated.
A Choice between one of the following:
day-of-week
The day of the week on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Every Monday. |
|
Every Tuesday. |
|
Every Wednesday. |
|
Every Thursday. |
|
Every Friday. |
|
Every Saturday. |
|
Every Sunday. |
day-of-month
The day of the month (from the 1st to the 28th) on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type uint8
- Value
-
a number in the range 1 to 28
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
frequency-list choice
Frequency options for running a scheduled task.
A Choice between one of the following:
weekly list
A list of schedules that specifies the days of the week and times of day to run the scheduled task
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
day-of-week
The day of the week on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Every Monday. |
|
Every Tuesday. |
|
Every Wednesday. |
|
Every Thursday. |
|
Every Friday. |
|
Every Saturday. |
|
Every Sunday. |
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
monthly list
A list of schedules that specifies the days of the month and times of day to run the scheduled task
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
day-of-month
The day of the month (from the 1st to the 28th) on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type uint8
- Value
-
a number in the range 1 to 28
rhino-node-id
The Rhino node identifier.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type rhino-node-id-type
- Description
-
The Rhino node identifier type.
- Value
-
a number in the range 1 to 32767
scheduled-rhino-restarts
Restart Rhino on a specified schedule, for maintenance purposes. If omitted, no Rhino restarts will be enabled.
Note: Please ensure there are no Rhino restarts within one hour of a scheduled Cassandra repair.
- When present
-
This container is optional, but has mandatory descendants.
scheduling-rule choice
Whether the scheduled task runs once or multiple times per interval.
A Choice between one of the following:
frequency choice
Frequency options for running a scheduled task.
Note: running a scheduled task in the single-entry format is deprecated.
A Choice between one of the following:
day-of-week
The day of the week on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Every Monday. |
|
Every Tuesday. |
|
Every Wednesday. |
|
Every Thursday. |
|
Every Friday. |
|
Every Saturday. |
|
Every Sunday. |
day-of-month
The day of the month (from the 1st to the 28th) on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type uint8
- Value
-
a number in the range 1 to 28
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
frequency-list choice
Frequency options for running a scheduled task.
A Choice between one of the following:
weekly list
A list of schedules that specifies the days of the week and times of day to run the scheduled task
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
day-of-week
The day of the week on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type enumeration
- Value
-
one of the following
| Value | Description |
|---|---|
|
Every Monday. |
|
Every Tuesday. |
|
Every Wednesday. |
|
Every Thursday. |
|
Every Friday. |
|
Every Saturday. |
|
Every Sunday. |
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
monthly list
A list of schedules that specifies the days of the month and times of day to run the scheduled task
|
|
This list should not have entries added or removed for an existing live deployment. The deployment must be deleted and redeployed for a change to this list to take effect. |
time-of-day
The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
This node is mandatory.
Type string
- Value
-
a string with length 0 or more matching
([0-1][0-9]|2[0-3]):[0-5][0-9]
day-of-month
The day of the month (from the 1st to the 28th) on which to run the scheduled task.
|
|
This value should never be changed for an existing live deployment. The deployment must be deleted and redeployed for a change to this value to take effect. |
Type uint8
- Value
-
a number in the range 1 to 28
