cloudRegions
  • Description: Identifies details about each cloud region
  • Type: Array of cloudRegion

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String

    perms (click for additional details)

    cloudId
    • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

    • Type: String

    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String
    regionName
    • DescriptionThe name of this cloud region as listed in the Supported Public Clouds section for the relevant release.
    • Type: String
    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String
    importRegion
    • Description: Identified the cloud region details
    • Type: Sequence of attributes

      name
      • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

      • Type: String

      displayName
      • DescriptionA descriptive name for this CloudCenter resource.
      • Type: String

    gateway (click for additional details)

    storage (click for additional details)

    enabled
    • Description: Indicates that this resource has been enabled. The default differs based on the resource.

      • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

      • false = The resource has not been enabled.

    • Type: Boolean

    activated
    • Description: Indicates whether this account has been activated.

      • true = the account has been activated
      • false = the account has not been activated
    • Type: Boolean
    publicCloud (Deprecated)
    • Description: Indicates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
    • Type: Boolean
      • true = This is a public cloud. See the Public Clouds section for the relevant release for a complete list.
      • false = This is not a public cloud. See the Datacenters and Private Clouds section for the relevant release for a complete list.
    numUsers
    • DescriptionNumber of users that are currently using this resource
    • Type: Long
    status
    • Description: Status of this resource 
    • Type: Enumeration

      EnumerationDescription
      RunningThe cloud account is operational
      StoppedThe cloud account is not operational
      MaintenanceModeThe cloud account is under maintenance
    statusDetail
    • Description: Indicates the status of this cloud
    • Type: Enumeration

      EnumerationDescription
      CLOUD_ACCOUNT_NOT_CONFIGUREDThere are no cloud accounts configured for this cloud.
      NO_REGION_RUNNINGThe cloud does not have a region that is in running state.
      RUNNINGThe cloud has at least one configured cloud account with at least one cloud region in running state
    regionProperties
    • Description: Properties for this region
    • TypeName-Value Pair (array)
    externalActions
    • Description: Defines the actions to be defined for each service for each phase when you create/update the service
    • Type: Array of service lifecycle actions. See the Service Lifecycle Actions section for the relevant release for additional context.

      actionName
      • Type: Enumeration
      actionType
      • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
      • Type: Enumeration

        EnumerationDescription
        SCRIPT

        Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

        The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
        - Linux VMs = /usr/local/osmosix/service/serviceName
        - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

        See the Service Lifecycle Action section for the relevant release for additional context.

         This option is not available for Container Service.

        URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

        The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
        CMD

        Indicates the command that is be executed on the VM during actionName step.

        The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

        - Linux VMs = cliqruser

        - WindowsVMs = cliqr

        See the Service Lifecycle Action section for the relevant release for additional context.

        Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

      actionValue
      • Description: Identifies the value that you provide for the selected actionType.

      • Type: String

     externalBundleLocation
    • Description: Location of the zip file that contains the external Bundle Store artifacts that are downloaded during deployment orchestration. 
      • The External Actions Bundle zip file contains all scripts required to manage the external lifecycle. You must provide the following information for this zip file depending on the resource being configured:

        • If you are configuring this file at the cloud region level – this file must contain a directory called cloudregion which contains all the scripts.

        • If you are configuring this file for a service – name this file as ServiceID.zip. For example, tomcat6.zip, where tomcat6 is the Service ID.

      • This attribute is available for all service types
      • The bundle is validated against associated repositories.
      • The repositories field should not be empty.
      • The Service Lifecycle Actions definition (if it is a SCRIPT) is used to locate the scripts in this ZIP file.
      • See Manage Services and the "Parameters and Macros" sections for the relevant release or additional context.
    • Type: String

    lastInstanceSyncTime
    • Description: Administrators have the ability to sync instance type and price information from the Package Store when they see a change in cloud provider instance type definitions and price information. This field identifies the date and time when the instance was last synced. See the Manage Instance Type section for additional details.
    • Type: Long

    Unable to render {include} The included page could not be found.

    cloudConnectStatus
    • Description: The state of the cloud connection. Effective CloudCenter Suite 5.0 and later releases.

    • Type: Enumeration

      EnumerationDescription
      WAITINGThe system is waiting to receive a status.
      CONNECTEDThe cloud is connected.
      NOT_APPLICABLEThe state does not apply to the CloudCenter Suite.

    strategyBundleLocation
    • Description: The location from where the CloudCenter Suite downloads the installation bundles. Effective CloudCenter Suite 5.0 and later releases.

    • Type: String

    strategy
    • Description:Identifies the overall strategy, properties, definitions, and restrictions for the cloud region. Effective CloudCenter 5.0.0 and later.

    • Type: Array of details for the cloud strategy

      properties
      • Description: Identifies the VM Naming and IPAM Strategies on a per cloud region basis (Strategy Bundle, Instance Naming Strategy, Node Name Config, Instance IPAM Strategy, Custom VM NAme, IPAM Alloc Rule, and IPAM Dealloc Rule – based on the information provided in the Guidance for Callout Scripts section).

      • Type: Array of strategy management details for each region


      propertyDefsType
      • Description: Identifies the  property value restrictions and the metadata definitions  for each property description.

      • Type: Array of value details

        propertyValueConstraintDefs
        • Description: Identifies the restrictions for each property value.
        • Type: String

        propertyMetadataDefs
        • Description: Information about the resource property

        • Type: Array of name-value pairs

          name
          • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

          • Type: String

          value
          • Description: Indicates the set value for this property
          • Type: Float

      strategyActions
      • Description: Identifies the possible actions for each strategy.

      • Type: Enumeration

        StrategyEnumerationDescription
        Instance IPAM Strategy

        IPAM_ALLOCThe location of your custom IPAM address allocation script
        IPAM_DEALLOCThe location of your custom IPAM address deallocation script.
        VM_NAMINGCalled before each node is launched. It is injected into the script with all the name variables (name of application, name of tier, image selected) for each job.
        Instance Naming Strategy

        DefaultThe default method provided by Cisco is generation of a string consisting of a predefined token prefixed with cqjw-
        CliQrMacroReplacementThe Node Name Config details are required.
        HostnameCalloutThe Custom VM Name details are required.

    externalActions
    • Description: Defines the actions to be defined for each service for each phase when you create/update the service
    • Type: Array of service lifecycle actions. See the Service Lifecycle Actions section for the relevant release for additional context.

      actionName
      • Type: Enumeration
      actionType
      • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
      • Type: Enumeration

        EnumerationDescription
        SCRIPT

        Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

        The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
        - Linux VMs = /usr/local/osmosix/service/serviceName
        - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

        See the Service Lifecycle Action section for the relevant release for additional context.

         This option is not available for Container Service.

        URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

        The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
        CMD

        Indicates the command that is be executed on the VM during actionName step.

        The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

        - Linux VMs = cliqruser

        - WindowsVMs = cliqr

        See the Service Lifecycle Action section for the relevant release for additional context.

        Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

      actionValue
      • Description: Identifies the value that you provide for the selected actionType.

      • Type: String

    actions (click for additional details)

     

© 2017-2019 Cisco Systems, Inc. All rights reserved