Declarative configuration decouples the configuration of components and their actual activation state from their declared desired state. This allows the platform to be configured with an intended configuration, with Rhino asynchronously making the required component state transitions to achieve the new configuration. This applies to services, resource adaptor entities, and the activation state of the SLEE.
The expected users of Rhino declarative configuration are tools that manage a cluster (or clusters) of Rhino nodes providing a service. These tools create and process documents based on the schemas for:
Notices
Copyright © 2024 Microsoft. All rights reserved
This manual is issued on a controlled basis to a specific person on the understanding that no part of the Metaswitch Networks product code or documentation (including this manual) will be copied or distributed without prior agreement in writing from Metaswitch Networks.
Metaswitch Networks reserves the right to, without notice, modify or revise all or part of this document and/or change product features or specifications and shall not be responsible for any loss, cost, or damage, including consequential damage, caused by reliance on these materials.
Metaswitch and the Metaswitch logo are trademarks of Metaswitch Networks. Other brands and products referenced herein are the trademarks or registered trademarks of their respective holders.
Declarative Config Import Result Schema
The status document returned by the importConfiguration MBean operation and importdeclarativeconfig rhino-console command. This document consists of a status value and details of the result of the import operation.
{
"$schema" : "https://json-schema.org/draft/2019-09/schema",
"$defs" : {
"ErrorWithContext" : {
"type" : "object",
"properties" : {
"context" : {
"$ref" : "#/$defs/Span",
"description" : "The context of the error in the configuration bundle."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
}
}
},
"JsonThrowable-nullable" : {
"type" : [ "object", "null" ],
"properties" : {
"message" : {
"type" : "string"
},
"stacktrace" : {
"type" : "string"
},
"type" : {
"type" : "string",
"description" : "Class of the exception or error"
}
}
},
"Level" : {
"type" : "string",
"enum" : [ "Info", "Warning", "Error" ]
},
"Location" : {
"type" : "object",
"properties" : {
"column" : {
"type" : "integer"
},
"line" : {
"type" : "integer"
}
}
},
"MergeErrorMessage" : {
"type" : "object",
"properties" : {
"context" : {
"$ref" : "#/$defs/Span",
"description" : "The context of the error in the configuration bundle."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
},
"selection" : {
"$ref" : "#/$defs/Span",
"description" : "Section of the configuration bundle that contains the conflicting values."
}
}
},
"SimpleErrorMessage" : {
"type" : "object",
"properties" : {
"cause" : {
"$ref" : "#/$defs/JsonThrowable-nullable",
"description" : "The cause of the error."
},
"level" : {
"$ref" : "#/$defs/Level",
"description" : "Severity level of the message."
},
"location" : {
"type" : [ "string", "null" ],
"description" : "YPath format path identifying the structural location in the configuration bundle where the error was found."
},
"message" : {
"type" : "string",
"description" : "Message text summarising the problem."
}
}
},
"Span" : {
"type" : "object",
"properties" : {
"end" : {
"$ref" : "#/$defs/Location",
"description" : "End location in the input document."
},
"name" : {
"type" : "string",
"description" : "File name of the input document. This is the configuration fragment name in a configuration bundle."
},
"start" : {
"$ref" : "#/$defs/Location",
"description" : "Start location in the input document."
},
"text" : {
"type" : "string",
"description" : "Text between the start and end locations in the input document."
}
}
},
"Status" : {
"type" : "string",
"enum" : [ "Success", "Failure" ]
}
},
"type" : "object",
"properties" : {
"deltas" : {
"type" : [ "string", "null" ],
"description" : "Description of the state changes that resulted from this import operation."
},
"messages" : {
"description" : "Error, warning and informational messages providing details of the status and reason returned.",
"type" : [ "array", "null" ],
"items" : {
"anyOf" : [ {
"$ref" : "#/$defs/SimpleErrorMessage"
}, {
"$ref" : "#/$defs/ErrorWithContext"
}, {
"$ref" : "#/$defs/MergeErrorMessage"
} ]
}
},
"reason" : {
"type" : [ "string", "null" ],
"description" : "Summary of why the import failed validation."
},
"status" : {
"$ref" : "#/$defs/Status",
"description" : "Overall status of the import operation (success or failure)."
}
}
}
Configuration Bundle Schema
This Reference follows the same structure as the configuration bundle.
config-bundle
Context
The context of config-bundle within the schema tree is shown. Italicised links are to other pages.
rhino-config:config-bundle format schema-version
A config-bundle is a package of desired state for configuration of SLEE components
- When present
-
config-bundle
format
The config bundle format
Type configuration-format
- Description
-
Configuration format is either complete or partial. Partial overlays configuration into Rhino. Complete replaces configuration in Rhino.
- Value
-
one of the following
| Value | Description |
|---|---|
|
complete replaces configuration in Rhino. |
|
partial overlays configuration in Rhino. |
rhino-configuration
Declarative configuration for SLEE components inside Rhino.
- When present
-
rhino-configuration
Context
The context of rhino-configuration within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list slee-components sbbs list sbb-parts list services list profile-specs list resource-adaptors list profile-tables list profile-spec-id profile-attributes list tracer-levels list usage-parameter-sets list profiles list resource-adaptor-entities list resource-adaptor-id config-properties list link-name-bindings list tracer-levels list usage-parameter-sets list states slee services list resource-adaptor-entities list
namespaces list
See namespaces list for details of this node and its descendants.
namespaces list
A namespace within Rhino.
List Structure
name string slee-components sbbs list name non-empty-string vendor non-empty-string version non-empty-string env-entries list name non-empty-string value string security-permission-spec string sbb-parts list name non-empty-string vendor non-empty-string version non-empty-string security-permission-spec string services list name non-empty-string vendor non-empty-string version non-empty-string default-sbb-tracer-levels list tracer-name string trace-level tracer-level present boolean sbbs list name non-empty-string vendor non-empty-string version non-empty-string tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean profile-specs list name non-empty-string vendor non-empty-string version non-empty-string resource-adaptors list name non-empty-string vendor non-empty-string version non-empty-string security-permission-spec string profile-tables list name string present boolean profile-spec-id name non-empty-string vendor non-empty-string version non-empty-string profile-attributes list name string type string serialised boolean serialisation-version string tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean profiles list name string present boolean attributes list name non-empty-string profile-attribute-value choice is-null is-null boolean content content string elements elements mappings mappings list key string present boolean value string resource-adaptor-entities list name non-empty-string present boolean resource-adaptor-id name non-empty-string vendor non-empty-string version non-empty-string config-properties list name non-empty-string value string present boolean link-name-bindings list link-name non-empty-string present boolean tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean states slee default-state slee-state nodes list node-id int16 present boolean state slee-state services list name non-empty-string vendor non-empty-string version non-empty-string default-state service-state nodes list node-id int16 present boolean state service-state resource-adaptor-entities list name non-empty-string default-state resource-adaptor-entity-state nodes list node-id int16 present boolean state resource-adaptor-entity-state
The key is name.
Context
The context of namespaces list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list name slee-components sbbs list sbb-parts list services list profile-specs list resource-adaptors list profile-tables list profile-spec-id profile-attributes list tracer-levels list usage-parameter-sets list profiles list resource-adaptor-entities list resource-adaptor-id config-properties list link-name-bindings list tracer-levels list usage-parameter-sets list states slee services list resource-adaptor-entities list
name
The name of the Rhino namespace, an empty string name means the default namespace.
Type string
- Value
-
a string
slee-components
See slee-components for details of this node and its descendants.
profile-tables list
See profile-tables list for details of this node and its descendants.
resource-adaptor-entities list
See resource-adaptor-entities list for details of this node and its descendants.
states
See states for details of this node and its descendants.
slee-components
The slee components deployed in a Rhino namespace.
Context
The context of slee-components within the schema tree is shown. Italicised links are to other pages.
sbbs list
See sbbs list for details of this node and its descendants.
sbb-parts list
See sbb-parts list for details of this node and its descendants.
services list
See services list for details of this node and its descendants.
profile-specs list
See profile-specs list for details of this node and its descendants.
resource-adaptors list
See resource-adaptors list for details of this node and its descendants.
sbbs list
Context
The context of sbbs list within the schema tree is shown. Italicised links are to other pages.
The SBB components in the Rhino namespace.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string env-entries list name non-empty-string value string security-permission-spec string
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
name
The name of the env-entry.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
sbb-parts list
Context
The context of sbb-parts list within the schema tree is shown. Italicised links are to other pages.
The SBB part components in the Rhino namespace.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string security-permission-spec string
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
services list
Context
The context of services list within the schema tree is shown. Italicised links are to other pages.
The Service components in the Rhino namespace.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string default-sbb-tracer-levels list tracer-name string trace-level tracer-level present boolean sbbs list name non-empty-string vendor non-empty-string version non-empty-string tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
default-sbb-tracer-levels list
This element is only used during a declarative import and will not be included in an export. During import, any tracer configurations specified here will be automatically applied to every SBB in the service, except where an SBB defines its own configuration for the same tracer name (which takes precedence).
trace-level
The trace level.
Type tracer-level
- Description
-
The trace level for a tracer
- Value
-
one of the following
| Value | Description |
|---|---|
|
off |
|
severe |
|
warning |
|
info |
|
config |
|
fine |
|
finer |
|
finest |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
sbbs list
The SBBs in the service that have tracer keys set, and/or usage parameter sets.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
trace-level
The trace level.
Type tracer-level
- Description
-
The trace level for a tracer
- Value
-
one of the following
| Value | Description |
|---|---|
|
off |
|
severe |
|
warning |
|
info |
|
config |
|
fine |
|
finer |
|
finest |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
name
The parameter set name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
profile-specs list
Context
The context of profile-specs list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list slee-components profile-specs list name vendor version
Profile spec refs in this namespace that have links or shadows.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
resource-adaptors list
Context
The context of resource-adaptors list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list slee-components resource-adaptors list name vendor version security-permission-spec
Resource Adaptor components in this namespace that have links or shadows.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string security-permission-spec string
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
profile-tables list
Profile Tables in this namespace.
List Structure
name string present boolean profile-spec-id name non-empty-string vendor non-empty-string version non-empty-string profile-attributes list name string type string serialised boolean serialisation-version string tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean profiles list name string present boolean attributes list name non-empty-string profile-attribute-value choice is-null is-null boolean content content string elements elements mappings mappings list key string present boolean value string
The key is name.
Context
The context of profile-tables list within the schema tree is shown. Italicised links are to other pages.
Data Validation Constraint
|
|
|
|
Validation Error: |
profile-spec-id must be specified for a profile table indicated to be present |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as present.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
profile-spec-id
See profile-spec-id for details of this node and its descendants.
profile-attributes list
See profile-attributes list for details of this node and its descendants.
tracer-levels list
See tracer-levels list for details of this node and its descendants.
usage-parameter-sets list
See usage-parameter-sets list for details of this node and its descendants.
profiles list
See profiles list for details of this node and its descendants.
profile-spec-id
Context
The context of profile-spec-id within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list profile-tables list profile-spec-id name vendor version
The profile component ID.
- When present
-
Presence means the profile table is present.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as profile-spec-id.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
profile-attributes list
Context
The context of profile-attributes list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list profile-tables list profile-attributes list name type serialised serialisation-version
Profile attributes in this profile table.
List Structure
name string type string serialised boolean serialisation-version string
The key is name.
serialised
Whether the profile attribute is serialised.
Related Constraint
Conditional node ../serialisation-version depends on this node. The Conditional expression refers to this node as ../serialised.
Type boolean
- Value
-
'true' or 'false'
serialisation-version
THe serialised version to use, if serialised is 'true'
Conditional
This leaf is only valid when ../serialised = 'true'.
Type string
- Value
-
a string
tracer-levels list
Context
The context of tracer-levels list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list profile-tables list tracer-levels list tracer-name trace-level present
Trace keys and their trace levels
trace-level
The trace level.
Type tracer-level
- Description
-
The trace level for a tracer
- Value
-
one of the following
| Value | Description |
|---|---|
|
off |
|
severe |
|
warning |
|
info |
|
config |
|
fine |
|
finer |
|
finest |
usage-parameter-sets list
Context
The context of usage-parameter-sets list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list profile-tables list usage-parameter-sets list name present
Usage parameter sets.
name
The parameter set name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
profiles list
Context
The context of profiles list within the schema tree is shown. Italicised links are to other pages.
The Profiles in the profile table.
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
name
The profile attribute’s name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
profile-attribute-value choice
A profile-attribute-value is one of is-null, str, an array, or a list of key-value mappings. Nested arrays are not supported.
This node is mandatory.
A Choice between one of the following:
content
The non-null content for a profile attribute. To be used for a single value attribute.
Type string
- Value
-
a string
elements
Represents an array. The format of this element is defined elsewhere.
Type YAML data as specified.
present
Indicates if this key should be present in the map.
Related Constraint
Conditional node ../value depends on this node. The Conditional expression refers to this node as ../present.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
value
The value (if present).
Conditional
This leaf is only valid when ../present = 'true'.
Type string
- Value
-
a string
resource-adaptor-entities list
The Resource Adaptor Entities in this namespace.
List Structure
name non-empty-string present boolean resource-adaptor-id name non-empty-string vendor non-empty-string version non-empty-string config-properties list name non-empty-string value string present boolean link-name-bindings list link-name non-empty-string present boolean tracer-levels list tracer-name string trace-level tracer-level present boolean usage-parameter-sets list name non-empty-string present boolean
The key is name.
Context
The context of resource-adaptor-entities list within the schema tree is shown. Italicised links are to other pages.
name
The resource adaptor entity name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
resource-adaptor-id
See resource-adaptor-id for details of this node and its descendants.
config-properties list
See config-properties list for details of this node and its descendants.
link-name-bindings list
See link-name-bindings list for details of this node and its descendants.
tracer-levels list
See tracer-levels list for details of this node and its descendants.
usage-parameter-sets list
See usage-parameter-sets list for details of this node and its descendants.
resource-adaptor-id
Context
The context of resource-adaptor-id within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list resource-adaptor-entities list resource-adaptor-id name vendor version
The resource adaptor entity component ID.
- When present
-
Presence means resource adaptor entity exists.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
config-properties list
Context
The context of config-properties list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list resource-adaptor-entities list config-properties list name value present
The resource adaptor entity’s config properties.
name
The config property name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
value
The config property value. Must be provided as per JAIN SLEE 1.1 Specification section 14.12.1.
This node is mandatory.
Type string
- Value
-
a string
link-name-bindings list
Context
The context of link-name-bindings list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list resource-adaptor-entities list link-name-bindings list link-name present
RA entity link name bindings.
link-name
RA entity link name binding.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
tracer-levels list
Context
The context of tracer-levels list within the schema tree is shown. Italicised links are to other pages.
Tracer levels for the RA entity.
trace-level
The tracer level.
Type tracer-level
- Description
-
The trace level for a tracer
- Value
-
one of the following
| Value | Description |
|---|---|
|
off |
|
severe |
|
warning |
|
info |
|
config |
|
fine |
|
finer |
|
finest |
usage-parameter-sets list
Context
The context of usage-parameter-sets list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list resource-adaptor-entities list usage-parameter-sets list name present
Usage parameter sets.
name
The parameter set name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
states
Per-node activation/lifecycle desired state related information.
- When present
-
states
slee
See slee for details of this node and its descendants.
services list
See services list for details of this node and its descendants.
resource-adaptor-entities list
See resource-adaptor-entities list for details of this node and its descendants.
slee
Context
The context of slee within the schema tree is shown. Italicised links are to other pages.
SLEE related activation state.
default-state
The desired state for the SLEE on each node unless overridden.
Type slee-state
- Description
-
The desired state of the SLEE in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
stopped |
|
running |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as present.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
state
The state for the SLEE on the node.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as state.
Type slee-state
- Description
-
The desired state of the SLEE in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
stopped |
|
running |
services list
Context
The context of services list within the schema tree is shown. Italicised links are to other pages.
Desired Activation state for services.
List Structure
name non-empty-string vendor non-empty-string version non-empty-string default-state service-state nodes list node-id int16 present boolean state service-state
The keys are name and vendor and version.
name
The component’s name
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
vendor
The component’s vendor
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
version
The component’s version
This node is mandatory.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
default-state
The state for the Service on every node unless overridden.
Type service-state
- Description
-
The desired state of a Service in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
inactive |
|
active |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as present.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
state
The desired service state for the node.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as state.
Type service-state
- Description
-
The desired state of a Service in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
inactive |
|
active |
resource-adaptor-entities list
Context
The context of resource-adaptor-entities list within the schema tree is shown. Italicised links are to other pages.
rhino-config:rhino-configuration namespaces list states resource-adaptor-entities list name default-state nodes list node-id present state
The desired resource adaptor entity state.
List Structure
name non-empty-string default-state resource-adaptor-entity-state nodes list node-id int16 present boolean state resource-adaptor-entity-state
The key is name.
name
The RA entity name.
Type non-empty-string
- Description
-
A non-empty-string has a positive, non-zero length
- Value
-
a string with length 1 or more
default-state
The default state for the RA entity on every node unless overridden.
Type resource-adaptor-entity-state
- Description
-
The desired state of a Resource Adaptor Entity in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
inactive |
|
active |
present
present: false is used with partial config bundles to indicate that Rhino will ensure any such named item or entity does not exist.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as present.
Type boolean
- Value
-
'true' or 'false'
- Default value
-
true
state
The desired RA entity state for the node.
Related Constraint
.. has a Data Validation Constraint which references this node. The validation expression refers to this node as state.
Type resource-adaptor-entity-state
- Description
-
The desired state of a Resource Adaptor Entity in a Rhino namespace
- Value
-
one of the following
| Value | Description |
|---|---|
|
inactive |
|
active |