SCC Upgrades service definition v1.0
Created Dec 18, 2020 at 07:15 PM

Resource: images

All available Riverbed software images

http://{device}/api/cmc.upgrades/1.0/images{?product_code}
  • JSON
  • [ image ]
    Property Name Type Description Notes
    images <array of <image>> All available Riverbed software images
    images[items] <image> A Riverbed software image

    Resource: image

    A Riverbed software image

    http://{device}/api/cmc.upgrades/1.0/images/{id}
  • JSON
  • {
      "id": string,
      "image_definition": image_definition,
      "image_sources": [ image_source ],
      <prop>: any
    }
    Property Name Type Description Notes
    image <object> A Riverbed software image Required properties: [id, image_definition, image_sources];
    image.id <string> A unique identifier for the image Read-only;
    image.image_definition <image_definition> Properties that uniquely identify a Riverbed software image
    image.image_sources <array of <image_source>>
    image.image_sources[items] <image_source> The source of the image. A repository can have multiple sources but particular source cannot be in more than one repository Values: local, customer_url, riverbed;
    image.<prop> <any> Optional;

    Resource: image_repositories

    An unmodifiable collection of all supported repositories

    http://{device}/api/cmc.upgrades/1.0/image_repositories
    Property Name Type Description Notes
    image_repositories <array of <image_repository>> An unmodifiable collection of all supported repositories
    image_repositories[items] <image_repository> An image repository provides a set of distinct images. The distinct meaning each has a different image definition Values: customer, riverbed;

    Resource: locally_hosted_images

    Riverbed software images hosted locally on the SCC

    http://{device}/api/cmc.upgrades/1.0/image_repositories/customer/local_images
    Property Name Type Description Notes
    locally_hosted_images <array of <locally_hosted_image>> Riverbed software images hosted locally on the SCC
    locally_hosted_images[items] <locally_hosted_image> A Riverbed software image hosted locally on the SCC

    Resource: locally_hosted_image

    A Riverbed software image hosted locally on the SCC

    http://{device}/api/cmc.upgrades/1.0/image_repositories/customer/local_image/{id}
  • JSON
  • {
      "id": string,
      "image_definition": image_definition,
      "modification_time": timestamp,
      <prop>: any
    }
    Property Name Type Description Notes
    locally_hosted_image <object> A Riverbed software image hosted locally on the SCC Required properties: [id, image_definition, modification_time];
    locally_hosted_image.id <string> A unique identifier Read-only;
    locally_hosted_image.image_definition <image_definition> Properties that uniquely identify a Riverbed software image
    locally_hosted_image.modification_time <timestamp> The timestamp of the build
    locally_hosted_image.<prop> <any> Optional;

    Resource: customer_url_hosted_images

    Riverbed software images hosted on a remote URL

    http://{device}/api/cmc.upgrades/1.0/image_repositories/customer/urls
    Property Name Type Description Notes
    customer_url_hosted_images <array of <customer_url_hosted_image>> Riverbed software images hosted on a remote URL
    customer_url_hosted_images[items] <customer_url_hosted_image> A Riverbed software image hosted on a remote URL

    Resource: customer_url_hosted_image

    A Riverbed software image hosted on a remote URL

    http://{device}/api/cmc.upgrades/1.0/image_repositories/customer/url/{id}
  • JSON
  • {
      "id": string,
      "image_definition": image_definition,
      "url": string,
      "registration_time": number,
      <prop>: any
    }
    Property Name Type Description Notes
    customer_url_hosted_image <object> A Riverbed software image hosted on a remote URL Required properties: [id, image_definition, url, registration_time];
    customer_url_hosted_image.id <string> A unique identifier
    customer_url_hosted_image.
    image_definition
    <image_definition> Properties that uniquely identify a Riverbed software image
    customer_url_hosted_image.url <string>
    registration_time <number> The time that the URL was registered
    customer_url_hosted_image.<prop> <any> Optional;

    Resource: riverbed_hosted_images

    Riverbed software images hosted by Riverbed Support

    http://{device}/api/cmc.upgrades/1.0/image_repositories/riverbed/images
    Property Name Type Description Notes
    riverbed_hosted_images <array of <riverbed_hosted_image>> Riverbed software images hosted by Riverbed Support
    riverbed_hosted_images[items] <riverbed_hosted_image> A Riverbed software image hosted by Riverbed Support

    Resource: riverbed_hosted_image

    A Riverbed software image hosted by Riverbed Support

    http://{device}/api/cmc.upgrades/1.0/image_repositories/riverbed/image/{id}
  • JSON
  • {
      "id": string,
      "image_definition": image_definition,
      "url": string,
      "source_versions": [ version ],
      <prop>: any
    }
    Property Name Type Description Notes
    riverbed_hosted_image <object> A Riverbed software image hosted by Riverbed Support Required properties: [image_definition, url, source_versions];
    riverbed_hosted_image.id <string> A unique identifier Optional;
    riverbed_hosted_image.image_definition <image_definition> Properties that uniquely identify a Riverbed software image
    riverbed_hosted_image.url <string>
    riverbed_hosted_image.source_versions <array of <version>> Source versions that Riverbed supports for upgrading
    riverbed_hosted_image.source_versions
    [items]
    <version> The version of a software image
    riverbed_hosted_image.<prop> <any> Optional;

    Resource: connected_product_codes

    A collection of unique product codes currently connected to the SCC

    http://{device}/api/cmc.upgrades/1.0/connected_product_codes
  • JSON
  • Property Name Type Description Notes
    connected_product_codes <array of <product_code>> A collection of unique product codes currently connected to the SCC
    connected_product_codes[items] <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;

    Resource: appliances

    A collection of appliances managed by the SCC

    http://{device}/api/cmc.upgrades/1.0/appliances/{product_code}
  • JSON
  • [ appliance ]
    Property Name Type Description Notes
    appliances <array of <appliance>> A collection of appliances managed by the SCC
    appliances[items] <appliance> Information about an appliance

    Resource: appliance

    Information about an appliance

    http://{device}/api/cmc.upgrades/1.0/appliances/{product_code}/{serial}
  • JSON
  • {
      "product_code": product_code,
      "arch": arch,
      "serial": serial,
      "model": string,
      "hostname": string,
      "ip_address": string,
      "current_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "connected": boolean,
      "time_zone": string,
      "entitled": boolean,
      "read_only": boolean,
      "groups": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    appliance <object> Information about an appliance Required properties: [product_code, serial, connected];
    appliance.product_code <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    appliance.arch <arch> The architecture of the appliance Values: x86_64, i386;
    appliance.serial <serial> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance.model <string> The model of the appliance Optional;
    appliance.hostname <string> The hostname of the appliance Optional;
    appliance.ip_address <string> The IP address of the appliance Optional;
    current_version <object> The RiOS version currently running on the appliance Required properties: [version_id];
    current_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    current_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    current_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    current_version.<prop> <any> Optional;
    appliance.connected <boolean> Appliance is connected or disconnected
    appliance.time_zone <string> Appliance time zone in the Olson database format Optional;
    appliance.entitled <boolean> Appliance is entitled or not Optional;
    appliance.read_only <boolean> Whether the user is able to upgrade, downgrade, or reboot Optional;
    appliance.groups <array of <string>> An array of groups the appliance belongs to Optional;
    appliance.groups[items] <string>
    appliance.<prop> <any> Optional;

    Relations

    appliance: instances

    Related resource

    appliances

    Resource: upgradeable_appliances

    Appliances that can be upgraded to a specified version

    http://{device}/api/cmc.upgrades/1.0/upgradeable_appliances/{product_code}/{version_id}
  • JSON
  • {
      "upgradeable": [ appliance ],
      "exceptions": {
        "unentitled": [ appliance ],
        "model_eol": [ appliance ],
        "read_only": [ appliance ],
        "disconnected": [ appliance ],
        "not_supported": [ appliance ],
        "no_i386_image": [ appliance ],
        "no_x86_64_image": [ appliance ],
        "operation_in_progress": [ appliance ],
        "same_or_newer_version": [ appliance ],
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    upgradeable_appliances <object> Appliances that can be upgraded to a specified version
    upgradeable_appliances.upgradeable <array of <appliance>> Optional;
    upgradeable_appliances.upgradeable
    [items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions <object> A list of appliances which cannot be upgraded categorized by reason Optional;
    upgradeable_appliances.exceptions.
    unentitled
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    unentitled[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    model_eol
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    model_eol[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    read_only
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    read_only[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    disconnected
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    disconnected[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    no_i386_image
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    no_i386_image[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    no_x86_64_image
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    no_x86_64_image[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    operation_in_progress
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    operation_in_progress[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.
    same_or_newer_version
    <array of <appliance>> Optional;
    upgradeable_appliances.exceptions.
    same_or_newer_version[items]
    <appliance> Information about an appliance
    upgradeable_appliances.exceptions.<prop> <any> Optional;
    upgradeable_appliances.exceptions.
    not_supported
    <array of <appliance>>
    upgradeable_appliances.exceptions.
    not_supported[items]
    <appliance> Information about an appliance
    upgradeable_appliances.<prop> <any> Optional;

    Resource: downgradeable_appliances

    Appliances that can be downgraded to a specified version. In the case of downgrades the version needs to have been previously upgraded. The images also have to be in the customer repository.

    http://{device}/api/cmc.upgrades/1.0/downgradeable_appliances/{product_code}/{version_id}
  • JSON
  • {
      "downgradeable": [ appliance ],
      "exceptions": {
        "read_only": [ appliance ],
        "disconnected": [ appliance ],
        "not_supported": [ appliance ],
        "not_previously_upgraded_to": [ appliance ],
        "no_i386_image": [ appliance ],
        "no_x86_64_image": [ appliance ],
        "operation_in_progress": [ appliance ],
        "same_or_older_version": [ appliance ],
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    downgradeable_appliances <object> Appliances that can be downgraded to a specified version. In the case of downgrades the version needs to have been previously upgraded. The images also have to be in the customer repository.
    downgradeable_appliances.downgradeable <array of <appliance>> Optional;
    downgradeable_appliances.downgradeable
    [items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions <object> A list of appliances that cannot be downgraded or categorized by reason Optional;
    downgradeable_appliances.exceptions.
    read_only
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    read_only[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    disconnected
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    disconnected[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    no_i386_image
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    no_i386_image[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    no_x86_64_image
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    no_x86_64_image[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    operation_in_progress
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    operation_in_progress[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    same_or_older_version
    <array of <appliance>> Optional;
    downgradeable_appliances.exceptions.
    same_or_older_version[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    <prop>
    <any> Optional;
    downgradeable_appliances.exceptions.
    not_supported
    <array of <appliance>>
    downgradeable_appliances.exceptions.
    not_supported[items]
    <appliance> Information about an appliance
    downgradeable_appliances.exceptions.
    not_previously_upgraded_to
    <array of <appliance>>
    downgradeable_appliances.exceptions.
    not_previously_upgraded_to[items]
    <appliance> Information about an appliance
    downgradeable_appliances.<prop> <any> Optional;

    Resource: rebootable_appliances

    Appliances that can be rebooted and a list of appliances that cannot

    http://{device}/api/cmc.upgrades/1.0/rebootable_appliances/{product_code}
  • JSON
  • {
      "rebootable": [ appliance ],
      "exceptions": {
        "read_only": [ appliance ],
        "disconnected": [ appliance ],
        "not_supported": [ appliance ],
        "operation_in_progress": [ appliance ],
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    rebootable_appliances <object> Appliances that can be rebooted and a list of appliances that cannot
    rebootable_appliances.rebootable <array of <appliance>> Optional;
    rebootable_appliances.rebootable[items] <appliance> Information about an appliance
    rebootable_appliances.exceptions <object> A list of appliances that cannot be rebooted or categorized by reason Optional;
    rebootable_appliances.exceptions.
    read_only
    <array of <appliance>> Optional;
    rebootable_appliances.exceptions.
    read_only[items]
    <appliance> Information about an appliance
    rebootable_appliances.exceptions.
    disconnected
    <array of <appliance>> Optional;
    rebootable_appliances.exceptions.
    disconnected[items]
    <appliance> Information about an appliance
    rebootable_appliances.exceptions.
    operation_in_progress
    <array of <appliance>> Optional;
    rebootable_appliances.exceptions.
    operation_in_progress[items]
    <appliance> Information about an appliance
    rebootable_appliances.exceptions.<prop> <any> Optional;
    rebootable_appliances.exceptions.
    not_supported
    <array of <appliance>>
    rebootable_appliances.exceptions.
    not_supported[items]
    <appliance> Information about an appliance
    rebootable_appliances.<prop> <any> Optional;

    Resource: upgradeable_versions

    A list of upgradeable versions for a specified product code

    http://{device}/api/cmc.upgrades/1.0/versions/upgradeable/{product_code}
  • JSON
  • [
      {
        "product_code": product_code,
        "version": version,
        <prop>: any
      }
    ]
    Property Name Type Description Notes
    upgradeable_versions <array of <object>> A list of upgradeable versions for a specified product code
    upgradeable_versions[items] <object>
    upgradeable_versions[items].product_code <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    upgradeable_versions[items].version <version> The version of a software image
    upgradeable_versions[items].<prop> <any> Optional;

    Resource: downgradeable_versions

    A list of downgradeable versions for a specified product code

    http://{device}/api/cmc.upgrades/1.0/versions/downgradeable/{product_code}
  • JSON
  • [
      {
        "product_code": product_code,
        "version": version,
        <prop>: any
      }
    ]
    Property Name Type Description Notes
    downgradeable_versions <array of <object>> A list of downgradeable versions for a specified product code
    downgradeable_versions[items] <object>
    downgradeable_versions[items].
    product_code
    <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    downgradeable_versions[items].version <version> The version of a software image
    downgradeable_versions[items].<prop> <any> Optional;

    Resource: upgrade_operations

    Upgrade operations

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade{?username,time_lower_bound,time_upper_bound,status}
    Property Name Type Description Notes
    upgrade_operations <array of <upgrade_operation>> Upgrade operations
    upgrade_operations[items] <upgrade_operation> Details about an upgrade operation

    Resource: upgrade_operation

    Details about an upgrade operation

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade/{id}
  • JSON
  • {
      "id": string,
      "username": string,
      "create_time": string,
      "status": string,
      "product_code": product_code,
      "upgrade_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "target_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "reboot": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "esxi_force": boolean,
      "comment": string,
      "reboot_id": number,
      "appliances": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    upgrade_operation <object> Details about an upgrade operation Required properties: [username, product_code, target_version, reboot, comment, appliances];
    upgrade_operation.id <string> A unique identifier for a operation Read-only; Optional;
    username <string> The name of the user that scheduled the operation or task Read-only;
    upgrade_operation.create_time <string> The time when the upgrade operation was created Read-only; Optional;
    status <string> The current state of the operation. Partially successful means that some of the operation's appliance tasks were successful but others were not Read-only; Values: scheduled, running, successful, partially_successful, failed, cancelled;
    upgrade_operation.product_code <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    upgrade_time <object> If specified, delay the operation until this date and time. The system stores this value as the UTC value of the upgrade time, regardless of the schedule type (local or UTC). Required properties: [datetime, time_type];
    upgrade_time.datetime <timestamp> The timestamp of the build
    upgrade_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    upgrade_time.<prop> <any> Optional;
    target_version <object> The software version to upgrade to Required properties: [version_id];
    target_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    target_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    target_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    target_version.<prop> <any> Optional;
    upgrade_operation.reboot <boolean> Whether to perform a reboot after upgrading
    reboot_time <object> If specified, delay the operation until this date and time. The system stores this value as the UTC value of the upgrade time, regardless of the schedule type (local or UTC). Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    upgrade_operation.esxi_force <boolean> Allow the upgrade to proceed even if it will result in replacing the currently installed version of ESXi or its configuration. Optional;
    upgrade_operation.comment <string> User comment for an operation
    upgrade_operation.reboot_id <number> Specifies the ID of the associated reboot operation if a reboot is requested after upgrade Optional;
    upgrade_operation.appliances <array of <items>> Appliances to upgrade
    items <string> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    upgrade_operation.<prop> <any> Optional;

    Relations

    upgrade_operation: upgrade_operation_log

    Related resource

    upgrade_operation_log

    Variables
    Related var Data value for replacement
    operation_id 0/id

    Resource: upgrade_operation_log

    Log messages associated with the operation

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade/{operation_id}/log
  • JSON
  • {
      "operation_id": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    upgrade_operation_log <object> Log messages associated with the operation
    upgrade_operation_log.operation_id <string> A unique identifier for the operation that the log belongs to Optional;
    upgrade_operation_log.log <log> A series of timestamped log entries
    upgrade_operation_log.<prop> <any> Optional;

    Resource: downgrade_operations

    Downgrade operations

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade{?username,time_lower_bound,time_upper_bound,status}
    Property Name Type Description Notes
    downgrade_operations <array of <downgrade_operation>> Downgrade operations
    downgrade_operations[items] <downgrade_operation> Details about an downgrade operation

    Resource: downgrade_operation

    Details about an downgrade operation

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade/{id}
  • JSON
  • {
      "id": string,
      "username": string,
      "create_time": string,
      "status": string,
      "product_code": product_code,
      "downgrade_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "target_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "reboot": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "esxi_force": boolean,
      "comment": string,
      "appliances": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    downgrade_operation <object> Details about an downgrade operation Required properties: [username, product_code, target_version, reboot, comment, appliances];
    downgrade_operation.id <string> A unique identifier for an operation Read-only; Optional;
    username <string> The name of the user that scheduled the operation or task Read-only;
    downgrade_operation.create_time <string> The time when the downgrade operation was created Read-only; Optional;
    status <string> The current state of the operation. Partially successful means that some of the operation's appliance tasks were successful but others were not Read-only; Values: scheduled, running, successful, partially_successful, failed, cancelled;
    downgrade_operation.product_code <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    downgrade_time <object> If specified, delay the operation until this date and time. The system stores this value as the UTC value of the upgrade time, regardless of the schedule type (local or UTC). Required properties: [datetime, time_type];
    downgrade_time.datetime <timestamp> The timestamp of the build
    downgrade_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    downgrade_time.<prop> <any> Optional;
    target_version <object> The software version to downgrade to Required properties: [version_id];
    target_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    target_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    target_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    target_version.<prop> <any> Optional;
    downgrade_operation.reboot <boolean> Whether to perform a reboot after downgrading
    reboot_time <object> If specified, delay the operation until this date and time. The system stores this value as the UTC value of the upgrade time, regardless of the schedule type (local or UTC). Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    downgrade_operation.esxi_force <boolean> Allow the downgrade to proceed even if it will result in replacing the currently installed version of ESXi or its configuration. Optional;
    downgrade_operation.comment <string> User comment for an operation
    downgrade_operation.appliances <array of <items>> Appliances to downgrade
    items <string> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    downgrade_operation.<prop> <any> Optional;

    Relations

    downgrade_operation: downgrade_operation_log

    Related resource

    downgrade_operation_log

    Variables
    Related var Data value for replacement
    operation_id 0/id

    Resource: downgrade_operation_log

    Log messages associated with the operation

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade/{operation_id}/log
  • JSON
  • {
      "operation_id": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    downgrade_operation_log <object> Log messages associated with the operation
    downgrade_operation_log.operation_id <string> A unique identifier for the operation that the log belongs to Optional;
    downgrade_operation_log.log <log> A series of timestamped log entries
    downgrade_operation_log.<prop> <any> Optional;

    Resource: reboot_operations

    Reboot operations

    http://{device}/api/cmc.upgrades/1.0/operations/reboot{?username,time_lower_bound,time_upper_bound,status}
    Property Name Type Description Notes
    reboot_operations <array of <reboot_operation>> Reboot operations
    reboot_operations[items] <reboot_operation> Details about a reboot operation

    Resource: reboot_operation

    Details about a reboot operation

    http://{device}/api/cmc.upgrades/1.0/operations/reboot/{id}
  • JSON
  • {
      "id": string,
      "username": string,
      "create_time": string,
      "status": string,
      "switch_partition": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "comment": string,
      "upgrade_id": string,
      "downgrade_id": string,
      "appliances": [
        string
      ],
      <prop>: any
    }
    Property Name Type Description Notes
    reboot_operation <object> Details about a reboot operation Required properties: [username, comment, appliances];
    reboot_operation.id <string> A unique identifier for an operation Read-only; Optional;
    username <string> The name of the user that scheduled the operation or task Read-only;
    reboot_operation.create_time <string> The time when the reboot operation was created Read-only; Optional;
    status <string> The current state of the operation. Partially successful means that some of the operation's appliance tasks were successful but others were not Read-only; Values: scheduled, running, successful, partially_successful, failed, cancelled;
    reboot_operation.switch_partition <boolean> Specifies whether to switch to the other partition. Treated as false if not specified. Optional;
    reboot_time <object> If specified, delay the operation until this date and time. The system stores this value as the UTC value of the upgrade time, regardless of the schedule type (local or UTC). Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    reboot_operation.comment <string> User comment for an operation
    reboot_operation.upgrade_id <string> The upgrade operation that triggered this reboot operation. Optional;
    reboot_operation.downgrade_id <string> The downgrade operation that triggered this reboot operation. Optional;
    reboot_operation.appliances <array of <items>>
    items <string> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    reboot_operation.<prop> <any> Optional;

    Relations

    reboot_operation: reboot_operation_log

    Related resource

    reboot_operation_log

    Variables
    Related var Data value for replacement
    operation_id 0/id

    Resource: reboot_operation_log

    Log messages associated with the operation

    http://{device}/api/cmc.upgrades/1.0/operations/reboot/{operation_id}/log
  • JSON
  • {
      "operation_id": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    reboot_operation_log <object> Log messages associated with the operation
    reboot_operation_log.operation_id <string> A unique identifier for the operation that the log belongs to Optional;
    reboot_operation_log.log <log> A series of timestamped log entries
    reboot_operation_log.<prop> <any> Optional;

    Resource: appliance_upgrade_task

    Details about the upgrade of a specific appliance in an operation

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade/{operation_id}/appliances/{serial}
  • JSON
  • {
      "operation_id": string,
      "serial": serial,
      "upgrade_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "task_start_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "target_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "reboot": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "esxi_force": boolean,
      "current_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "hostname": string,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_upgrade_task <object> Details about the upgrade of a specific appliance in an operation Required properties: [operation_id, target_version, reboot, current_version];
    appliance_upgrade_task.operation_id <string> A unique identifier for the operation that the appliance task belongs to
    appliance_upgrade_task.serial <serial> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    upgrade_time <object> If specified, delay the operation until this date and time, adjusted for the local time of the device being upgraded, if scheduling in local time. Required properties: [datetime, time_type];
    upgrade_time.datetime <timestamp> The timestamp of the build
    upgrade_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    upgrade_time.<prop> <any> Optional;
    task_start_time <object> The time when the task was actually run Required properties: [datetime, time_type];
    task_start_time.datetime <timestamp> The timestamp of the build
    task_start_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    task_start_time.<prop> <any> Optional;
    target_version <object> The software version to upgrade to Required properties: [version_id];
    target_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    target_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    target_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    target_version.<prop> <any> Optional;
    appliance_upgrade_task.reboot <boolean> Whether to perform a reboot after upgrading
    reboot_time <object> If specified, delay the operation until this date and time, adjusted for the local time of the device being upgraded, if scheduling in local time. Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    appliance_upgrade_task.esxi_force <boolean> Optional;
    current_version <object> The software version on this appliance at the time the operation was scheduled Required properties: [version_id];
    current_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    current_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    current_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    current_version.<prop> <any> Optional;
    appliance_upgrade_task.hostname <string> Hostname of the appliance Optional;
    appliance_upgrade_task.<prop> <any> Optional;

    Relations

    appliance_upgrade_task: operation

    Related resource

    upgrade_operation

    Variables
    Related var Data value for replacement
    id 0/operation_id

    appliance_upgrade_task: appliance

    Related resource

    appliance

    Variables
    Related var Data value for replacement
    serial 0/serial

    appliance_upgrade_task: appliance_upgrade_task_state

    Related resource

    appliance_upgrade_task_state

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    appliance_upgrade_task: appliance_upgrade_task_log

    Related resource

    appliance_upgrade_task_log

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    Resource: appliance_upgrade_task_state

    The status of the upgrade of a single appliance of an operation

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade/{operation_id}/appliances/{serial}/state
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "status": appliance_task_status,
      "stage": appliance_upgrade_task_stage,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_upgrade_task_state <object> The status of the upgrade of a single appliance of an operation Required properties: [status, stage];
    appliance_upgrade_task_state.
    operation_id
    <string> A unique identifier for the operation that the appliance task belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_upgrade_task_state.status <appliance_task_status> The current task status of the per appliance Values: scheduled, running, successful, failed, cancelled;
    appliance_upgrade_task_state.stage <appliance_upgrade_task_stage> The current progress of the appliance upgrade task Values: waiting, initiating, downloading, patching, installing, completed, failed, cancelled;
    appliance_upgrade_task_state.<prop> <any> Optional;

    Resource: appliance_upgrade_task_log

    Log messages associated with the appliance task

    http://{device}/api/cmc.upgrades/1.0/operations/upgrade/{operation_id}/appliances/{serial}/log
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_upgrade_task_log <object> Log messages associated with the appliance task
    appliance_upgrade_task_log.operation_id <string> A unique identifier for the operation that the log belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_upgrade_task_log.log <log> A series of timestamped log entries
    appliance_upgrade_task_log.<prop> <any> Optional;

    Resource: appliance_downgrade_task

    Details about the downgrade of a specific appliance in an operation

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade/{operation_id}/appliances/{serial}
  • JSON
  • {
      "operation_id": string,
      "serial": serial,
      "downgrade_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "task_start_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "target_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "reboot": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "esxi_force": boolean,
      "current_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      "hostname": string,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_downgrade_task <object> Details about the downgrade of a specific appliance in an operation Required properties: [operation_id, serial, target_version, reboot, current_version];
    appliance_downgrade_task.operation_id <string> A unique identifier for the operation that the appliance task belongs to
    appliance_downgrade_task.serial <serial> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    downgrade_time <object> If specified, delay the operation until this date and time, adjusted for the local time of the device being upgraded, if scheduling in local time. Required properties: [datetime, time_type];
    downgrade_time.datetime <timestamp> The timestamp of the build
    downgrade_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    downgrade_time.<prop> <any> Optional;
    task_start_time <object> The time when the task was actually run Required properties: [datetime, time_type];
    task_start_time.datetime <timestamp> The timestamp of the build
    task_start_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    task_start_time.<prop> <any> Optional;
    target_version <object> The software version to downgrade to Required properties: [version_id];
    target_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    target_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    target_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    target_version.<prop> <any> Optional;
    appliance_downgrade_task.reboot <boolean> Whether to perform a reboot after downgrading
    reboot_time <object> If specified, delay the operation until this date and time, adjusted for the local time of the device being upgraded, if scheduling in local time. Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    appliance_downgrade_task.esxi_force <boolean> Optional;
    current_version <object> The software version on this appliance at the time the operation was scheduled Required properties: [version_id];
    current_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    current_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    current_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    current_version.<prop> <any> Optional;
    appliance_downgrade_task.hostname <string> Hostname of the appliance Optional;
    appliance_downgrade_task.<prop> <any> Optional;

    Relations

    appliance_downgrade_task: operation

    Related resource

    downgrade_operation

    Variables
    Related var Data value for replacement
    id 0/operation_id

    appliance_downgrade_task: appliance

    Related resource

    appliance

    Variables
    Related var Data value for replacement
    serial 0/serial

    appliance_downgrade_task: appliance_downgrade_task_state

    Related resource

    appliance_downgrade_task_state

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    appliance_downgrade_task: appliance_downgrade_task_log

    Related resource

    appliance_downgrade_task_log

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    Resource: appliance_downgrade_task_state

    The status of the downgrade of a single appliance of an operation

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade/{operation_id}/appliances/{serial}/state
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "status": appliance_task_status,
      "stage": appliance_downgrade_task_stage,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_downgrade_task_state <object> The status of the downgrade of a single appliance of an operation Required properties: [status, stage];
    appliance_downgrade_task_state.
    operation_id
    <string> A unique identifier for the operation that the appliance task belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_downgrade_task_state.status <appliance_task_status> The current task status of the per appliance Values: scheduled, running, successful, failed, cancelled;
    appliance_downgrade_task_state.stage <appliance_downgrade_task_stage> The current progress of the per appliance downgrade task Values: waiting, initiating, downloading, installing, completed, failed, cancelled;
    appliance_downgrade_task_state.<prop> <any> Optional;

    Resource: appliance_downgrade_task_log

    Log messages associated with the appliance task

    http://{device}/api/cmc.upgrades/1.0/operations/downgrade/{operation_id}/appliances/{serial}/log
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_downgrade_task_log <object> Log messages associated with the appliance task
    appliance_downgrade_task_log.
    operation_id
    <string> A unique identifier for the operation that the log belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_downgrade_task_log.log <log> A series of timestamped log entries
    appliance_downgrade_task_log.<prop> <any> Optional;

    Resource: appliance_reboot_task

    The status of the reboot of a single appliance of an operation

    http://{device}/api/cmc.upgrades/1.0/operations/reboot/{operation_id}/appliances/{serial}
  • JSON
  • {
      "operation_id": string,
      "serial": serial,
      "switch_partition": boolean,
      "reboot_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "task_start_time": {
        "datetime": timestamp,
        "time_type": string,
        <prop>: any
      },
      "deferred": boolean,
      "hostname": string,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_reboot_task <object> The status of the reboot of a single appliance of an operation Required properties: [operation_id, serial];
    appliance_reboot_task.operation_id <string> A unique identifier for the operation that the appliance task belongs to
    appliance_reboot_task.serial <serial> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_reboot_task.switch_partition <boolean> Specifies whether to switch to the other partition. Treated as false if not specified. Optional;
    reboot_time <object> If specified, delay the operation until this date and time, adjusted for the local time of the device being upgraded, if scheduling in local time. Required properties: [datetime, time_type];
    reboot_time.datetime <timestamp> The timestamp of the build
    reboot_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    reboot_time.<prop> <any> Optional;
    task_start_time <object> The time when the task was actually run Required properties: [datetime, time_type];
    task_start_time.datetime <timestamp> The timestamp of the build
    task_start_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    task_start_time.<prop> <any> Optional;
    appliance_reboot_task.deferred <boolean> Specifies whether the reboot task should be enabled for execution. This would be set to false if the reboot is linked to an upgrade and the upgrade is not completed yet. Optional;
    appliance_reboot_task.hostname <string> Hostname of the appliance. Optional;
    appliance_reboot_task.<prop> <any> Optional;

    Relations

    appliance_reboot_task: operation

    Related resource

    reboot_operation

    Variables
    Related var Data value for replacement
    id 0/operation_id

    appliance_reboot_task: appliance

    Related resource

    appliance

    Variables
    Related var Data value for replacement
    serial 0/serial

    appliance_reboot_task: appliance_reboot_task_state

    Related resource

    appliance_reboot_task_state

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    appliance_reboot_task: appliance_reboot_task_log

    Related resource

    appliance_reboot_task_log

    Variables
    Related var Data value for replacement
    operation_id 0/operation_id
    serial 0/serial

    Resource: appliance_reboot_task_state

    The status of the reboot of a single appliance of an operation

    http://{device}/api/cmc.upgrades/1.0/operations/reboot/{operation_id}/appliances/{serial}/state
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "status": appliance_task_status,
      "stage": appliance_reboot_task_stage,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_reboot_task_state <object> The status of the reboot of a single appliance of an operation Required properties: [status, stage];
    appliance_reboot_task_state.operation_id <string> A unique identifier for the operation that the appliance task belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_reboot_task_state.status <appliance_task_status> The current task status of the per appliance Values: scheduled, running, successful, failed, cancelled;
    appliance_reboot_task_state.stage <appliance_reboot_task_stage> The current progress of the per appliance reboot task Values: waiting, initiating, rebooting, reboot_wait, completed, failed, cancelled;
    appliance_reboot_task_state.<prop> <any> Optional;

    Resource: appliance_reboot_task_log

    Log messages associated with the appliance task

    http://{device}/api/cmc.upgrades/1.0/operations/reboot/{operation_id}/appliances/{serial}/log
  • JSON
  • {
      "operation_id": string,
      "serial": string,
      "log": log,
      <prop>: any
    }
    Property Name Type Description Notes
    appliance_reboot_task_log <object> Log messages associated with the appliance task
    appliance_reboot_task_log.operation_id <string> A unique identifier for the operation which the log belongs to Read-only; Optional;
    serial <string> The serial number of the appliance Read-only; Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';
    appliance_reboot_task_log.log <log> A series of timestamped log entries
    appliance_reboot_task_log.<prop> <any> Optional;

    Resource: logging

    Service logging parameters

    http://{device}/api/cmc.upgrades/1.0/logging
  • JSON
  • {
      "level": logging_level,
      <prop>: any
    }
    Property Name Type Description Notes
    logging <object> Service logging parameters Required properties: [level];
    logging.level <logging_level> Severity levels for logs emitted by the service Values: crit, err, warning, notice, info, debug;
    logging.<prop> <any> Optional;

    Type: product_code

    The product code of the appliance

  • JSON
  • string
    Property Name Type Description Notes
    product_code <string> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;

    Type: arch

    The architecture of the appliance

  • JSON
  • string
    Property Name Type Description Notes
    arch <string> The architecture of the appliance Values: x86_64, i386;

    Type: serial

    The serial number of the appliance

  • JSON
  • string
    Property Name Type Description Notes
    serial <string> The serial number of the appliance Pattern: '^[A-Za-z][0-9A-Fa-f]{2}[A-Za-z]{0,2}[0-9A-Fa-f]{8}$';

    Type: image_definition

    Properties that uniquely identify a Riverbed software image

  • JSON
  • {
      "product_code": product_code,
      "arch": arch,
      "target_version": version,
      "delta": boolean,
      "source_version": {
        "version_id": string,
        "version_number": string,
        "build_number": string,
        "build_timestamp": number,
        <prop>: any
      },
      <prop>: any
    }
    Property Name Type Description Notes
    image_definition <object> Properties that uniquely identify a Riverbed software image Required properties: [product_code, arch, target_version, delta];
    image_definition.product_code <product_code> The product code of the appliance Values: SH, EX, IC, SMC, WW, GC;
    image_definition.arch <arch> The architecture of the appliance Values: x86_64, i386;
    image_definition.target_version <version> The version of a software image
    image_definition.delta <boolean> Whether the image is a delta image
    source_version <object> The source version (if delta image is true) Required properties: [version_id];
    source_version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    source_version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    source_version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    source_version.<prop> <any> Optional;
    image_definition.<prop> <any> Optional;

    Type: image_repository

    An image repository provides a set of distinct images. The distinct meaning each has a different image definition

  • JSON
  • string
    Property Name Type Description Notes
    image_repository <string> An image repository provides a set of distinct images. The distinct meaning each has a different image definition Values: customer, riverbed;

    Type: image_source

    The source of the image. A repository can have multiple sources but particular source cannot be in more than one repository

  • JSON
  • string
    Property Name Type Description Notes
    image_source <string> The source of the image. A repository can have multiple sources but particular source cannot be in more than one repository Values: local, customer_url, riverbed;

    Type: version

    The version of a software image

  • JSON
  • {
      "version_id": string,
      "version_number": string,
      "build_number": string,
      "build_timestamp": number,
      <prop>: any
    }
    Property Name Type Description Notes
    version <object> The version of a software image Required properties: [version_id];
    version.version_id <string> A unique identifier for a version of a product. Is an amalgem of all the information in the following fields
    version.version_number <string> The released version name. A dotted decimal with optional trailing characters to identify fix releases and customer specific releases Optional;
    version.build_number <string> The build number. Distinguishes prerelease versions. For any given general availability version_number there is a specific build number Optional;
    build_timestamp <number> The date and time of the build
    version.<prop> <any> Optional;

    Type: timestamp

    The timestamp of the build

  • JSON
  • number
    Property Name Type Description Notes
    timestamp <number> The timestamp of the build

    Type: username

    The name of the user that scheduled the operation or task

  • JSON
  • string
    Property Name Type Description Notes
    username <string> The name of the user that scheduled the operation or task

    Type: operation_status

    The current state of the operation. Partially successful means that some of the operation's appliance tasks were successful but others were not

  • JSON
  • string
    Property Name Type Description Notes
    operation_status <string> The current state of the operation. Partially successful means that some of the operation's appliance tasks were successful but others were not Values: scheduled, running, successful, partially_successful, failed, cancelled;

    Type: appliance_task_status

    The current task status of the per appliance

  • JSON
  • string
    Property Name Type Description Notes
    appliance_task_status <string> The current task status of the per appliance Values: scheduled, running, successful, failed, cancelled;

    Type: appliance_upgrade_task_stage

    The current progress of the appliance upgrade task

  • JSON
  • string
    Property Name Type Description Notes
    appliance_upgrade_task_stage <string> The current progress of the appliance upgrade task Values: waiting, initiating, downloading, patching, installing, completed, failed, cancelled;

    Type: appliance_downgrade_task_stage

    The current progress of the per appliance downgrade task

  • JSON
  • string
    Property Name Type Description Notes
    appliance_downgrade_task_stage <string> The current progress of the per appliance downgrade task Values: waiting, initiating, downloading, installing, completed, failed, cancelled;

    Type: appliance_reboot_task_stage

    The current progress of the per appliance reboot task

  • JSON
  • string
    Property Name Type Description Notes
    appliance_reboot_task_stage <string> The current progress of the per appliance reboot task Values: waiting, initiating, rebooting, reboot_wait, completed, failed, cancelled;

    Type: scheduled_time

    The date and time of the run operation

  • JSON
  • {
      "datetime": timestamp,
      "time_type": string,
      <prop>: any
    }
    Property Name Type Description Notes
    scheduled_time <object> The date and time of the run operation Required properties: [datetime, time_type];
    scheduled_time.datetime <timestamp> The timestamp of the build
    scheduled_time.time_type <string> Whether this represents an absolute time or the local time of the managed appliance Values: utc, local;
    scheduled_time.<prop> <any> Optional;

    Type: log_entry

    A timestamped log line

  • JSON
  • {
      "timestamp": timestamp,
      "log_entry": string,
      "severity": string,
      <prop>: any
    }
    Property Name Type Description Notes
    log_entry <object> A timestamped log line Required properties: [timestamp, severity, log_entry];
    log_entry.timestamp <timestamp> The timestamp of the build
    log_entry.log_entry <string>
    log_entry.severity <string> Values: emerg, alert, crit, err, warning, notice, info, debug;
    log_entry.<prop> <any> Optional;

    Type: log

    A series of timestamped log entries

  • JSON
  • [ log_entry ]
    Property Name Type Description Notes
    log <array of <log_entry>> A series of timestamped log entries
    log[items] <log_entry> A timestamped log line

    Type: logging_level

    Severity levels for logs emitted by the service

  • JSON
  • string
    Property Name Type Description Notes
    logging_level <string> Severity levels for logs emitted by the service Values: crit, err, warning, notice, info, debug;