ConfigurationState (type)

{
  "id": "ConfigurationState", 
  "module_id": "Common", 
  "properties": {
    "details": {
      "items": {
        "$ref": "ConfigurationStateElement
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Array of configuration state of various sub systems", 
      "type": "array"
    }, 
    "failure_code": {
      "readonly": true, 
      "required": false, 
      "title": "Error code", 
      "type": "integer"
    }, 
    "failure_message": {
      "readonly": true, 
      "required": false, 
      "title": "Error message in case of failure", 
      "type": "string"
    }, 
    "state": {
      "description": "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.", 
      "enum": [
        "pending", 
        "in_progress", 
        "success", 
        "failed", 
        "partial_success", 
        "orphaned", 
        "unknown", 
        "error", 
        "in_sync", 
        "NOT_AVAILABLE", 
        "VM_DEPLOYMENT_QUEUED", 
        "VM_DEPLOYMENT_IN_PROGRESS", 
        "VM_DEPLOYMENT_FAILED", 
        "VM_POWER_ON_IN_PROGRESS", 
        "VM_POWER_ON_FAILED", 
        "REGISTRATION_PENDING", 
        "NODE_NOT_READY", 
        "NODE_READY", 
        "VM_POWER_OFF_IN_PROGRESS", 
        "VM_POWER_OFF_FAILED", 
        "VM_UNDEPLOY_IN_PROGRESS", 
        "VM_UNDEPLOY_FAILED", 
        "VM_UNDEPLOY_SUCCESSFUL", 
        "EDGE_CONFIG_ERROR", 
        "VM_DEPLOYMENT_RESTARTED", 
        "REGISTRATION_FAILED", 
        "TRANSPORT_NODE_SYNC_PENDING", 
        "TRANSPORT_NODE_CONFIGURATION_MISSING", 
        "EDGE_HARDWARE_NOT_SUPPORTED", 
        "MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED", 
        "TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER", 
        "TZ_ENDPOINTS_NOT_SPECIFIED", 
        "NO_PNIC_PREPARED_IN_EDGE", 
        "APPLIANCE_INTERNAL_ERROR", 
        "VTEP_DHCP_NOT_SUPPORTED", 
        "UNSUPPORTED_HOST_SWITCH_PROFILE", 
        "UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED", 
        "HOSTSWITCH_PROFILE_NOT_FOUND", 
        "LLDP_SEND_ENABLED_NOT_SUPPORTED", 
        "UNSUPPORTED_NAMED_TEAMING_POLICY", 
        "LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM", 
        "LACP_NOT_SUPPORTED_FOR_EDGE_VM", 
        "STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM", 
        "MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE", 
        "UNSUPPORTED_LACP_LB_ALGO_FOR_NODE", 
        "EDGE_NODE_VERSION_NOT_SUPPORTED", 
        "NO_PNIC_SPECIFIED_IN_TN", 
        "INVALID_PNIC_DEVICE_NAME", 
        "TRANSPORT_NODE_READY", 
        "VM_NETWORK_EDIT_PENDING", 
        "UNSUPPORTED_DEFAULT_TEAMING_POLICY", 
        "MPA_DISCONNECTED", 
        "VM_RENAME_PENDING", 
        "VM_CONFIG_EDIT_PENDING", 
        "VM_NETWORK_EDIT_FAILED", 
        "VM_RENAME_FAILED", 
        "VM_CONFIG_EDIT_FAILED", 
        "VM_CONFIG_DISCREPANCY", 
        "VM_NODE_REFRESH_FAILED", 
        "VM_PLACEMENT_REFRESH_FAILED", 
        "REGISTRATION_TIMEDOUT"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Overall state of desired configuration", 
      "type": "string"
    }
  }, 
  "title": "Describes status of configuration of an entity", 
  "type": "object"
}