Developer Documentation


Describes status of configuration of an entity


Required Property Name Type Description
optional details array of ConfigurationStateElement

Array of configuration state of various sub systems

optional failure_code integer

Error code

optional failure_message string

Error message in case of failure

optional state string

Gives details of state of desired configuration. Additional enums with more details on progress/success/error states are sent for edge node. The success states are NODE_READY and TRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED, VM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values indicate failures. “in_sync” state indicates that the desired configuration has been received by the host to which it applies, but is not yet in effect. When the configuration is actually in effect, the state will change to “success”. Please note, failed state is deprecated.

Extended By


Was this page helpful?