deployment-id

The deployment identifier. Used to form a unique VM identifier within the VM host.

Warning

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.

Warning

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.

Warning

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

''

sentinel-ipsmgw-enabled

Whether Sentinel IPSMGW will be installed and enabled on SMO nodes.

Warning

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.

Related Constraints

Conditional node ../../sentinel-ipsmgw depends on this node. The Conditional expression refers to this node as ../smo-virtual-machine-pool/sentinel-ipsmgw-enabled.

Conditional node ../rhino-auth depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw-enabled.

Conditional node ../additional-rhino-jvm-options depends on this node. The Conditional expression refers to this node as ../sentinel-ipsmgw-enabled.

Type boolean

Value

'true' or 'false'

cassandra-contact-points list

A list of Cassandra contact points. These should normally not be specified as this option is intended for testing and/or special use cases.

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\.]*

additional-rhino-jvm-options list

Additional JVM options to use when running Rhino. Should normally be left blank.

Warning

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.

Conditional

This list is only valid when ../sentinel-ipsmgw-enabled = 'true'.

List Structure

name string
value string

The key is name.

name

Name of the JVM option. Do not include '-D'.

Warning

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.

Warning

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.

Conditional

This list is only valid when ../sentinel-ipsmgw-enabled = 'true'.

Must contain at least 1 element.

List Structure

username string
password secret
role enumeration

The key is username.

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

admin

Administrator role. Can make changes to Rhino configuration.

view

Read-only role. Cannot make changes to Rhino configuration.

Default value

'view'

virtual-machines list

Configured virtual machines.

Warning

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.

vm-id

The unique virtual machine identifier.

Warning

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

per-node-diameter-ro

Configuration for Diameter Ro.

If sentinel-ipsmgw-enabled is set to false, omit this.

Conditional

This container is only valid when ../../../sentinel-ipsmgw/charging-options/diameter-ro.

Container Structure

diameter-ro-origin-host

The Diameter Ro origin host.

Warning

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]\.?)|\.

sip-local-uri

SIP URI for this node.

If sentinel-ipsmgw-enabled is set to false, specify an arbitrary placeholder value here.

This node is mandatory.

Type sip-uri-type

Description

The SIP URI type.

Value

a string with length 0 or more matching sip:.*

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:

daily

No description available

Container Structure


weekly

No description available

Container Structure

day-of-week

The day of the week on which to run the scheduled task.

Warning

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

Monday

Every Monday.

Tuesday

Every Tuesday.

Wednesday

Every Wednesday.

Thursday

Every Thursday.

Friday

Every Friday.

Saturday

Every Saturday.

Sunday

Every Sunday.

monthly

No description available

Container Structure

day-of-month

The day of the month (from the 1st to the 28th) on which to run the scheduled task.

Warning

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.

Warning

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

Warning

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

day-of-week enumeration
time-of-day string

The key is day-of-week.

day-of-week

The day of the week on which to run the scheduled task.

Warning

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

Monday

Every Monday.

Tuesday

Every Tuesday.

Wednesday

Every Wednesday.

Thursday

Every Thursday.

Friday

Every Friday.

Saturday

Every Saturday.

Sunday

Every Sunday.

time-of-day

The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.

Warning

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

Warning

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

day-of-month uint8
time-of-day string

The key is day-of-month.

day-of-month

The day of the month (from the 1st to the 28th) on which to run the scheduled task.

Warning

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.

Warning

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]

rhino-node-id

Rhino node identifier.

If sentinel-ipsmgw-enabled is set to false, specify an arbitrary placeholder value here.

Warning

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:

daily

No description available

Container Structure


weekly

No description available

Container Structure

day-of-week

The day of the week on which to run the scheduled task.

Warning

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

Monday

Every Monday.

Tuesday

Every Tuesday.

Wednesday

Every Wednesday.

Thursday

Every Thursday.

Friday

Every Friday.

Saturday

Every Saturday.

Sunday

Every Sunday.

monthly

No description available

Container Structure

day-of-month

The day of the month (from the 1st to the 28th) on which to run the scheduled task.

Warning

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.

Warning

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

Warning

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

day-of-week enumeration
time-of-day string

The key is day-of-week.

day-of-week

The day of the week on which to run the scheduled task.

Warning

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

Monday

Every Monday.

Tuesday

Every Tuesday.

Wednesday

Every Wednesday.

Thursday

Every Thursday.

Friday

Every Friday.

Saturday

Every Saturday.

Sunday

Every Sunday.

time-of-day

The time of day (24hr clock in the system’s timezone) at which to run the scheduled task.

Warning

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

Warning

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

day-of-month uint8
time-of-day string

The key is day-of-month.

day-of-month

The day of the month (from the 1st to the 28th) on which to run the scheduled task.

Warning

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.

Warning

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]

Previous page Next page
Rhino VoLTE TAS Version 4.1