Update Image

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameUpdate Image
Description

Updates the specified image for the specified cloud region

Allowed Role(s)WM_USER
MethodPUT
URI

v1/tenants/tenantId/images/imageId

cloudcenter-ccm-backend/api/v1/tenants/tenantId/images/imageId

Sample Request
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/images/2"
curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/images/2"
Release

Introduced in CloudCenter 4.0

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: update.tenants.tenantId.images.imageId

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Request Body

{
    "id": 2,
    "name": "Ubuntu 12.04",
    "description": "Ubuntu 12.04",
    "visibility": "PUBLIC",
    "numOfNics": "2",
    "osName": "LINUX",
    "enabled": true,
    "imageType": "CLOUD_WORKER"
}

Response

{
    "id": "2",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/images/2",
    "perms": [],
    "name": "Ubuntu 12.04",
    "internalImageName": "CloudWorker-Ubuntu12.04",
    "description": "Ubuntu 12.04",
    "visibility": "PUBLIC",
    "imageType": "CLOUD_WORKER",
    "osName": "LINUX",
    "tags": [],
    "numOfNics": 2,
    "tenantId": 1,
    "enabled": true,
    "systemImage": true,
    "detail": null,
    "count": 3
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String

Required

imageId
  • DescriptionUnique, system-generated identifier for a logically mapped image (see Manage Images for additional context).
  • Type: String

Required

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

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

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
visibility
  • Description: Indicates the type of user to which this image is visible
  • Type: Enumeration

    EnumerationDescription
    PRIVATEThis image is visible only to the tenant owner admin
    PUBLICThis image is visible to all tenants and users.
    PUBLISHEDThis image is visible only to tenant users.
numOfNics
  • Description: The number of Network Interface Cards (NICs) attached to this instance type or cloud image.

  • Type: Integer
osName
  • Description: Type of operating system associated with this resource
  • Type: Enumeration

    EnumerationDescription
    LINUXThe associated resource is specific to the Linux operating system.
    WINDOWSThe associated resource is specific to the Windows operating system.
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

imageType
  • Description: Identifies whether this image is for the CCO or the application VM
  • Type: Enumeration

    EnumerationDescription
    CLOUD_GATEWAYThe CCO image
    CLOUD_WORKERThe application VM image

Response Attributes

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)
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

internalImageName
  • Description: The internal name for this image 
  • Type: String
description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
visibility
  • Description: Indicates the type of user to which this image is visible
  • Type: Enumeration

    EnumerationDescription
    PRIVATEThis image is visible only to the tenant owner admin
    PUBLICThis image is visible to all tenants and users.
    PUBLISHEDThis image is visible only to tenant users.
imageType
  • Description: Identifies whether this image is for the CCO or the application VM
  • Type: Enumeration

    EnumerationDescription
    CLOUD_GATEWAYThe CCO image
    CLOUD_WORKERThe application VM image
osName
  • Description: Type of operating system associated with this resource
  • Type: Enumeration

    EnumerationDescription
    LINUXThe associated resource is specific to the Linux operating system.
    WINDOWSThe associated resource is specific to the Windows operating system.
tags
  • DescriptionTags associated with this resource. Each string represents a system tag. See the System Tags section for the relevant release for additional context.

    If you filter reports based on tags that you applied to VMs or jobs, then the report displays all the VMs or jobs that have this exact combination of tags.

  • Type: Array of strings

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

systemImage
  • Description: Indicates whether this image is a predefined system image (see Manage Images for additional context):
    • true =  A predefined system image
    • false = Not a predefined system image
  • Type: Boolean 

detail (click for more details)

If the request URL does not have a detail query parameter with the value=true, then this field displays null.

count
  • Description: The number of times that this phase bundle was added/attached.

    On successful image creation, this value will always remain 0.

  • TypeInteger






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