Previous Topic: BFC API ExamplesNext Topic: Version URIs


Version Records

This section contains the following topics:

Version Record

ESX Version Record

Hotfix Record

The following section describes Version records.

Version Record

The version record is used to return information about the CA AppLogic versions that are available using the BFC. Those versions in the resource_running_state are available for use in grid creation using the BFC API. The version record contains the following fields:

Field

Type

Description

comp_id

integer

Read-only field that contains the resource component ID for the grid version resource.

name

string

Read-only field that contains the name of the CA AppLogic grid version resource. For example, 3.1.9.

state

string

Read-only field that contains the resource state of the version, for example, resource_allocated_state, resource_running_state.

Note: When a user deletes a version through the BFC interface, this operation unimports the version. The version component remains in the system and its state is set to resource_allocated_state. If the user reimports the version into the BFC, the version retains its previous component id.

state_info

string

Read-only field used for detailed status information about the version. Currently, this field always sets to null in the version record returned to BFC API users.

size

integer

Read-only field containing the size of this CA AppLogic version in MBytes.

esx_enabled

boolean

Read-only boolean field that indicates whether an ESX version has been imported into this CA AppLogic version.

supported_esx_versions

[esx version]

Read-only field that contains a list of esx_version records representing the list of ESX versions supported by this CA AppLogic grid version resource.

imported_esx_version

esx version records

Read-only field that contains an esx_version record when the esx_enabled field is set to true. It represents the specific ESX version that has been imported into this CA AppLogic version.

required_bfc_version

string

Read-only field that contains the minimum version of the BFC that is required to use this CA AppLogic version. For example, 3.0.0.

hotfixes

[hotfix]

Read-only field that contains a list of hotfix records corresponding to the set of CA AppLogic hotfixes and language packs associated with this CA AppLogic version.

download_info

string

Read-only field that will be used for detailed download information for this CA AppLogic version. Currently, this field will always be null in the version record returned to BFC API users.

ESX Version Record

The esx_version record contains information about a particular ESX version.

Field

Type

Description

version

string

Read-only field that contains the ESX version. For example, 4.0.

update

string

Read-only field that contains the ESX update for the specified version. For example, 2.

build

string

Read-only field that contains the ESX build for the specified version and update. For example, 261974.

Hotfix Record

The hotfix record contains information about a CA AppLogic language pack or hotfix.

Field

Type

Description

comp_id

integer

Specifies the read-only field that contains the resource component ID for this CA AppLogic hotfix.

name

string

Specifies the read-only field that contains the CA AppLogic language pack or hotfix name. For example, lp4631-Japanese or hf12447.

size

integer

Read-only field containing the size of this hotfix in MBytes.

description

string

Specifies the read-only field that contains a brief desription of the hotfix.

info_url

string

Specifies the read-only field that contains a URL that points to details information about the hotfix.

state

string

Specifies the read-only field that contains the resource state of the language pack or hotfix. For example, resource_allocated_state, resource_running_state.

state_info

string

Read-only field used for detailed status information about the hotfix. Currently, this field always sets to null in the hotfix record returned to BFC API users.

version_name

string

Specifies the read-only field that contains the name of the CA AppLogic version with which this hotfix is associated.

download_info

string

Read-only field used for detailed download information about the hotfix. Currently, this field sets to null in the hotfix record returned to BFC API users.