# ApiDeployment2 Data Model

This objects represents a deployment including all clusters, hosts, services, roles, etc in the system. It can be used to save and restore all settings. This model will be used v18 and beyond since users will be represented by ApiUser2 v18 and beyond.

Properties
name | data type | description
--- | --- | ---
timestamp | string | Readonly. This timestamp is provided when you request a deployment and is not required (or even read) when creating a deployment. This timestamp is useful if you have multiple deployments saved and want to determine which one to use as a restore point.
clusters | array of ApiCluster | List of clusters in the system including their services, roles and complete config values.
hosts | array of ApiHost | List of hosts in the system
authRoles | array of ApiAuthRole | List of all auth roles in the system Available from v32
externalUserMappings | array of ApiExternalUserMapping | List of all external user mappings in the system Available from v32
users | array of ApiUser2 | List of all users in the system
versionInfo | ApiVersionInfo | Full version information about the running Cloudera Manager instance
managementService | ApiService | The full configuration of the Cloudera Manager management service including all the management roles and their config values
managerSettings | ApiConfigList | The full configuration of Cloudera Manager itself including licensing info
allHostsConfig | ApiConfigList | Configuration parameters that apply to all hosts, unless overridden at the host level. Available since API v3.
peers | array of ApiCmPeer | The list of peers configured in Cloudera Manager. Available since API v3.
hostTemplates | ApiHostTemplateList | The list of all host templates in Cloudera Manager.
dataContexts | ApiDataContextList | The list of all the data contexts in the Cloudera Manager.

Example

    {
      "timestamp" : "...",
      "clusters" : [ {
        "name" : "...",
        "displayName" : "...",
        "fullVersion" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ],
        "services" : [ {
          "name" : "...",
          "type" : "...",
          "clusterRef" : { },
          "serviceState" : "STARTED",
          "healthSummary" : "BAD",
          "configStalenessStatus" : "STALE_REFRESHABLE",
          "clientConfigStalenessStatus" : "STALE",
          "healthChecks" : [ { }, { } ],
          "serviceUrl" : "...",
          "roleInstancesUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ],
          "config" : { },
          "roles" : [ { }, { } ],
          "displayName" : "...",
          "roleConfigGroups" : [ { }, { } ],
          "replicationSchedules" : [ { }, { } ],
          "snapshotPolicies" : [ { }, { } ],
          "entityStatus" : "CONCERNING_HEALTH",
          "tags" : [ { }, { } ],
          "serviceVersion" : "..."
        }, {
          "name" : "...",
          "type" : "...",
          "clusterRef" : { },
          "serviceState" : "NA",
          "healthSummary" : "NOT_AVAILABLE",
          "configStalenessStatus" : "STALE_REFRESHABLE",
          "clientConfigStalenessStatus" : "STALE",
          "healthChecks" : [ { }, { } ],
          "serviceUrl" : "...",
          "roleInstancesUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
          "config" : { },
          "roles" : [ { }, { } ],
          "displayName" : "...",
          "roleConfigGroups" : [ { }, { } ],
          "replicationSchedules" : [ { }, { } ],
          "snapshotPolicies" : [ { }, { } ],
          "entityStatus" : "STARTING",
          "tags" : [ { }, { } ],
          "serviceVersion" : "..."
        } ],
        "parcels" : [ {
          "product" : "...",
          "version" : "...",
          "stage" : "...",
          "state" : { },
          "clusterRef" : { },
          "displayName" : "...",
          "description" : "..."
        }, {
          "product" : "...",
          "version" : "...",
          "stage" : "...",
          "state" : { },
          "clusterRef" : { },
          "displayName" : "...",
          "description" : "..."
        } ],
        "clusterUrl" : "...",
        "hostsUrl" : "...",
        "entityStatus" : "STARTING",
        "uuid" : "...",
        "dataContextRefs" : [ {
          "name" : "..."
        }, {
          "name" : "..."
        } ],
        "clusterType" : "...",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      }, {
        "name" : "...",
        "displayName" : "...",
        "fullVersion" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "HOST", "SERVICE" ],
        "services" : [ {
          "name" : "...",
          "type" : "...",
          "clusterRef" : { },
          "serviceState" : "STARTED",
          "healthSummary" : "DISABLED",
          "configStalenessStatus" : "STALE",
          "clientConfigStalenessStatus" : "FRESH",
          "healthChecks" : [ { }, { } ],
          "serviceUrl" : "...",
          "roleInstancesUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ],
          "config" : { },
          "roles" : [ { }, { } ],
          "displayName" : "...",
          "roleConfigGroups" : [ { }, { } ],
          "replicationSchedules" : [ { }, { } ],
          "snapshotPolicies" : [ { }, { } ],
          "entityStatus" : "CONCERNING_HEALTH",
          "tags" : [ { }, { } ],
          "serviceVersion" : "..."
        }, {
          "name" : "...",
          "type" : "...",
          "clusterRef" : { },
          "serviceState" : "UNKNOWN",
          "healthSummary" : "CONCERNING",
          "configStalenessStatus" : "STALE",
          "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
          "healthChecks" : [ { }, { } ],
          "serviceUrl" : "...",
          "roleInstancesUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
          "config" : { },
          "roles" : [ { }, { } ],
          "displayName" : "...",
          "roleConfigGroups" : [ { }, { } ],
          "replicationSchedules" : [ { }, { } ],
          "snapshotPolicies" : [ { }, { } ],
          "entityStatus" : "DOWN",
          "tags" : [ { }, { } ],
          "serviceVersion" : "..."
        } ],
        "parcels" : [ {
          "product" : "...",
          "version" : "...",
          "stage" : "...",
          "state" : { },
          "clusterRef" : { },
          "displayName" : "...",
          "description" : "..."
        }, {
          "product" : "...",
          "version" : "...",
          "stage" : "...",
          "state" : { },
          "clusterRef" : { },
          "displayName" : "...",
          "description" : "..."
        } ],
        "clusterUrl" : "...",
        "hostsUrl" : "...",
        "entityStatus" : "NONE",
        "uuid" : "...",
        "dataContextRefs" : [ {
          "name" : "..."
        }, {
          "name" : "..."
        } ],
        "clusterType" : "...",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      } ],
      "hosts" : [ {
        "hostId" : "...",
        "ipAddress" : "...",
        "hostname" : "...",
        "rackId" : "...",
        "lastHeartbeat" : "...",
        "roleRefs" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "NOT_AVAILABLE",
          "roleStatus" : "STOPPING"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "DISABLED",
          "roleStatus" : "BUSY"
        } ],
        "healthSummary" : "BAD",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "BAD",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "DISABLED",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "isParcelInfoAvailable" : true,
        "hostUrl" : "...",
        "maintenanceMode" : true,
        "commissionState" : "UNKNOWN",
        "maintenanceOwners" : [ "ROLE", "SERVICE" ],
        "config" : {
          "items" : [ { }, { } ]
        },
        "numCores" : 12345,
        "numPhysicalCores" : 12345,
        "totalPhysMemBytes" : 12345,
        "entityStatus" : "STOPPED",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "distribution" : {
          "distributionType" : "DEBIAN_JESSIE",
          "name" : "...",
          "version" : "..."
        },
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      }, {
        "hostId" : "...",
        "ipAddress" : "...",
        "hostname" : "...",
        "rackId" : "...",
        "lastHeartbeat" : "...",
        "roleRefs" : [ {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "NOT_AVAILABLE",
          "roleStatus" : "STOPPING"
        }, {
          "clusterName" : "...",
          "serviceName" : "...",
          "roleName" : "...",
          "healthSummary" : "BAD",
          "roleStatus" : "NA"
        } ],
        "healthSummary" : "DISABLED",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "DISABLED",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "BAD",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "isParcelInfoAvailable" : true,
        "hostUrl" : "...",
        "maintenanceMode" : true,
        "commissionState" : "DECOMMISSIONING",
        "maintenanceOwners" : [ "ROLE", "ROLE" ],
        "config" : {
          "items" : [ { }, { } ]
        },
        "numCores" : 12345,
        "numPhysicalCores" : 12345,
        "totalPhysMemBytes" : 12345,
        "entityStatus" : "UNKNOWN_HEALTH",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "distribution" : {
          "distributionType" : "RHEL7_PPC64LE",
          "name" : "...",
          "version" : "..."
        },
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ]
      } ],
      "authRoles" : [ {
        "displayName" : "...",
        "name" : "...",
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "users" : [ {
          "name" : "..."
        }, {
          "name" : "..."
        } ],
        "externalUserMappings" : [ {
          "uuid" : "...",
          "name" : "...",
          "type" : "EXTERNAL_PROGRAM"
        }, {
          "uuid" : "...",
          "name" : "...",
          "type" : "LDAP"
        } ],
        "baseRole" : {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        },
        "uuid" : "...",
        "isCustom" : true
      }, {
        "displayName" : "...",
        "name" : "...",
        "clusters" : [ {
          "clusterName" : "...",
          "displayName" : "..."
        }, {
          "clusterName" : "...",
          "displayName" : "..."
        } ],
        "users" : [ {
          "name" : "..."
        }, {
          "name" : "..."
        } ],
        "externalUserMappings" : [ {
          "uuid" : "...",
          "name" : "...",
          "type" : "EXTERNAL_PROGRAM"
        }, {
          "uuid" : "...",
          "name" : "...",
          "type" : "LDAP"
        } ],
        "baseRole" : {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        },
        "uuid" : "...",
        "isCustom" : true
      } ],
      "externalUserMappings" : [ {
        "name" : "...",
        "type" : "EXTERNAL_PROGRAM",
        "uuid" : "...",
        "authRoles" : [ {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        }, {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        } ]
      }, {
        "name" : "...",
        "type" : "LDAP",
        "uuid" : "...",
        "authRoles" : [ {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        }, {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        } ]
      } ],
      "users" : [ {
        "name" : "...",
        "password" : "...",
        "authRoles" : [ {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        }, {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        } ],
        "pwHash" : "...",
        "pwSalt" : 12345,
        "pwLogin" : true
      }, {
        "name" : "...",
        "password" : "...",
        "authRoles" : [ {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        }, {
          "displayName" : "...",
          "name" : "...",
          "uuid" : "..."
        } ],
        "pwHash" : "...",
        "pwSalt" : 12345,
        "pwLogin" : true
      } ],
      "versionInfo" : {
        "version" : "...",
        "snapshot" : true,
        "buildUser" : "...",
        "buildTimestamp" : "...",
        "gitHash" : "..."
      },
      "managementService" : {
        "name" : "...",
        "type" : "...",
        "clusterRef" : {
          "clusterName" : "...",
          "displayName" : "..."
        },
        "serviceState" : "STARTED",
        "healthSummary" : "CONCERNING",
        "configStalenessStatus" : "STALE",
        "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
        "healthChecks" : [ {
          "name" : "...",
          "summary" : "DISABLED",
          "explanation" : "...",
          "suppressed" : true
        }, {
          "name" : "...",
          "summary" : "HISTORY_NOT_AVAILABLE",
          "explanation" : "...",
          "suppressed" : true
        } ],
        "serviceUrl" : "...",
        "roleInstancesUrl" : "...",
        "maintenanceMode" : true,
        "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ],
        "config" : {
          "roleTypeConfigs" : [ { }, { } ],
          "items" : [ { }, { } ]
        },
        "roles" : [ {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "UNKNOWN",
          "commissionState" : "UNKNOWN",
          "healthSummary" : "GOOD",
          "configStalenessStatus" : "STALE",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "STANDBY",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "UNKNOWN",
          "entityStatus" : "STARTING",
          "tags" : [ { }, { } ]
        }, {
          "name" : "...",
          "type" : "...",
          "hostRef" : { },
          "serviceRef" : { },
          "roleState" : "HISTORY_NOT_AVAILABLE",
          "commissionState" : "DECOMMISSIONED",
          "healthSummary" : "CONCERNING",
          "configStalenessStatus" : "STALE",
          "healthChecks" : [ { }, { } ],
          "haStatus" : "ACTIVE",
          "roleUrl" : "...",
          "maintenanceMode" : true,
          "maintenanceOwners" : [ "SERVICE", "HOST" ],
          "config" : { },
          "roleConfigGroupRef" : { },
          "zooKeeperServerMode" : "REPLICATED_FOLLOWER",
          "entityStatus" : "HISTORY_NOT_AVAILABLE",
          "tags" : [ { }, { } ]
        } ],
        "displayName" : "...",
        "roleConfigGroups" : [ {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        }, {
          "name" : "...",
          "roleType" : "...",
          "base" : true,
          "config" : { },
          "displayName" : "...",
          "serviceRef" : { }
        } ],
        "replicationSchedules" : [ {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "DAY",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        }, {
          "hdfsArguments" : { },
          "hiveArguments" : { },
          "hdfsCloudArguments" : { },
          "ozoneReplicationArguments" : { },
          "history" : [ { }, { } ],
          "active" : true,
          "hiveCloudArguments" : { },
          "hbaseArguments" : { },
          "hive3Arguments" : { },
          "rangerArguments" : { },
          "icebergArguments" : { },
          "atlasReplicationArguments" : { },
          "id" : 12345,
          "displayName" : "...",
          "description" : "...",
          "startTime" : "...",
          "endTime" : "...",
          "interval" : 12345,
          "intervalUnit" : "WEEK",
          "nextRun" : "...",
          "paused" : true,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true
        } ],
        "snapshotPolicies" : [ {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        }, {
          "name" : "...",
          "description" : "...",
          "hourlySnapshots" : 12345,
          "dailySnapshots" : 12345,
          "weeklySnapshots" : 12345,
          "monthlySnapshots" : 12345,
          "yearlySnapshots" : 12345,
          "minuteOfHour" : 12345,
          "hoursForHourlySnapshots" : [ 12345, 12345 ],
          "hourOfDay" : 12345,
          "dayOfWeek" : 12345,
          "dayOfMonth" : 12345,
          "monthOfYear" : 12345,
          "alertOnStart" : true,
          "alertOnSuccess" : true,
          "alertOnFail" : true,
          "alertOnAbort" : true,
          "hbaseArguments" : { },
          "hdfsArguments" : { },
          "ozoneArguments" : { },
          "lastCommand" : { },
          "lastSuccessfulCommand" : { },
          "paused" : true
        } ],
        "entityStatus" : "STARTING",
        "tags" : [ {
          "name" : "...",
          "value" : "..."
        }, {
          "name" : "...",
          "value" : "..."
        } ],
        "serviceVersion" : "..."
      },
      "managerSettings" : {
        "items" : [ {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "OK",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        }, {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "ERROR",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        } ]
      },
      "allHostsConfig" : {
        "items" : [ {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "ERROR",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        }, {
          "name" : "...",
          "value" : "...",
          "required" : true,
          "default" : "...",
          "displayName" : "...",
          "description" : "...",
          "relatedName" : "...",
          "sensitive" : true,
          "validationState" : "ERROR",
          "validationMessage" : "...",
          "validationWarningsSuppressed" : true
        } ]
      },
      "peers" : [ {
        "name" : "...",
        "type" : "REPLICATION",
        "url" : "...",
        "username" : "...",
        "password" : "...",
        "clouderaManagerCreatedUser" : true,
        "createUserWithAdminRole" : true
      }, {
        "name" : "...",
        "type" : "STATUS_AGGREGATION",
        "url" : "...",
        "username" : "...",
        "password" : "...",
        "clouderaManagerCreatedUser" : true,
        "createUserWithAdminRole" : true
      } ],
      "hostTemplates" : {
        "items" : [ {
          "name" : "...",
          "clusterRef" : { },
          "roleConfigGroupRefs" : [ { }, { } ]
        }, {
          "name" : "...",
          "clusterRef" : { },
          "roleConfigGroupRefs" : [ { }, { } ]
        } ]
      },
      "dataContexts" : {
        "items" : [ {
          "name" : "...",
          "displayName" : "...",
          "nameservice" : "...",
          "createdTime" : "...",
          "lastModifiedTime" : "...",
          "services" : [ { }, { } ],
          "servicesDetails" : [ { }, { } ],
          "supportedServiceTypes" : [ "...", "..." ],
          "allowedClusterVersions" : [ { }, { } ],
          "configStalenessStatus" : "STALE",
          "clientConfigStalenessStatus" : "STALE",
          "healthSummary" : "BAD"
        }, {
          "name" : "...",
          "displayName" : "...",
          "nameservice" : "...",
          "createdTime" : "...",
          "lastModifiedTime" : "...",
          "services" : [ { }, { } ],
          "servicesDetails" : [ { }, { } ],
          "supportedServiceTypes" : [ "...", "..." ],
          "allowedClusterVersions" : [ { }, { } ],
          "configStalenessStatus" : "STALE",
          "clientConfigStalenessStatus" : "STALE",
          "healthSummary" : "GOOD"
        } ]
      }
    }