hypervisor-networks

csp-machine-images

Operations on cloud service provider (CSP) machine images.

Operations

csp-machine-instance-types

Operations on cloud service provider (CSP) machine instance types.

Operations

csp-machine-instances

Operations on cloud service provider (CSP) machine instances.

Operations

datastores

The datastores API allows the registration and management of datastores.

Operations

hypervisor-clusters

The hypervisor clusters API enables you to get the details of the hypervisor clusters in a hypervisor manager.

Operations

hypervisor-folders

The hypervisor folders API enables you to get the details of the hypervisor folders in a hypervisor manager.

Operations

hypervisor-hosts

The hypervisor hosts API enables you to get the details of the hypervisor hosts in a hypervisor manager.

Operations

hypervisor-managers

The hypervisor managers API allows the registration and management of hypervisor managers.

Operations

hypervisor-networks

The hypervisor networks API enables you to get the details of the hypervisor networks in a hypervisor manager.

Operations

Get a hypervisor network resource identified by {network-id}

Request

Details of a hypervisors network resource.

Security

bearer

Path

hypervisor-idstringrequired

UUID string uniquely identifying the hypervisor manager.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4

network-idstringrequired

UUID string uniquely identifying the hypervisor network resource.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/hypervisor-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/networks/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

idstringrequired

UUID string uniquely identifying the hypervisor network resource.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required

Time in UTC at which the object was created.

updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

appInfoobject

Application specific information for this network.

customerIdstring

The customer application identifier.

displayNamestring

A user-friendly name that identifies the hypervisor network. This will always be same as name since adding or updating hypervisor networks is not supported when managed from a manager, such as the vCenter.

Example: "vmNetwork"

hostsInfoArray of objects

List of hypervisor hosts to which this network is presented to.

hypervisorManagerInfoobject

namestring<= 255 charactersread-only

Name of the network as reported by the hypervisor manager.

Example: "vmNetwork"

resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-managers/{hypervisor-id}/networks/{network-id}"

servicesArray of strings(Services)

List of services this object belongs to. This list can be used to filter specific services in the UI.

statestring

The current state of the hypervisor network.

Enum"OK""ERROR""REFRESHING"

stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor network.

statusstring

The current status of the hypervisor network. Status is derived and abstracted to a 'standard status' based on the status reported by the hypervisor manager.

Enum"OK""ERROR""WARNING"

Response

application/json

{
  "appInfo": {
    "vmware": { … }
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "displayName": "vmNetwork",
  "generation": 0,
  "hostsInfo": [
    { … }
  ],
  "hypervisorManagerInfo": {
    "displayName": "myvcenter1",
    "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
    "name": "vcenter123.hpe.com",
    "resourceUri": "string",
    "type": "string"
  },
  "id": "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4",
  "name": "vmNetwork",
  "resourceUri": "/virtualization/v1beta1/hypervisor-managers/{hypervisor-id}/networks/{network-id}",
  "services": [
    "hci-manager",
    "backup-and-recovery"
  ],
  "state": "OK",
  "stateReason": "string",
  "status": "OK",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Get all network resources in a registered hypervisor manager.

Request

List all the network resources in a registered hypervisor manager.

Security

bearer

Path

uuidstringrequired

UUID string uniquely identifying the hypervisor manager.

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4

Query

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger(int32)[ 1 .. 1000 ]

The numbers of items to return

Default 20

filterstring

The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter.

A comparison compares a property name to a literal. The following comparisons are supported:

“eq” : Is a property equal to value. Valid for number, boolean and string properties.
“ne” : Is a property not equal to value. Valid for number, boolean and string properties.
“gt” : Is a property greater than a value. Valid for number or string timestamp properties.
“lt” : Is a property less than a value. Valid for number or string timestamp properties
“in” : Is a value in a property (that is an array of strings)

Examples:

GET /virtualization/v1beta1/hypervisor-managers/{uuid}/networks?filter="status eq ERROR"

Filters are supported on the following attributes:

state
status
createdAt
name
services
displayName

sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified, the default order is ascending.

selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/virtualization/public/openapi/virtualization-public-v1beta1/virtualization/v1beta1/hypervisor-managers/9b4c14a6-3cd5-4907-97c4-cf44c5b641e4/networks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

countintegerrequired

Total number of records returned.

itemsArray of objects(HypervisorNetwork)required

items[].idstringrequired

UUID string uniquely identifying the hypervisor network resource.

Example: "9b4c14a6-3cd5-4907-97c4-cf44c5b641e4"

items[].typestringread-onlyrequired

The type of resource.

items[].generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].createdAtstring(date-time)required

Time in UTC at which the object was created.

items[].updatedAtstring(date-time)required

Time in UTC at which the object was last updated.

items[].appInfoobject

Application specific information for this network.

items[].customerIdstring

The customer application identifier.

items[].displayNamestring

A user-friendly name that identifies the hypervisor network. This will always be same as name since adding or updating hypervisor networks is not supported when managed from a manager, such as the vCenter.

Example: "vmNetwork"

items[].hostsInfoArray of objects

List of hypervisor hosts to which this network is presented to.

items[].hypervisorManagerInfoobject

items[].namestring<= 255 charactersread-only

Name of the network as reported by the hypervisor manager.

Example: "vmNetwork"

items[].resourceUristring

The 'self' reference for this resource.

Example: "/virtualization/v1beta1/hypervisor-managers/{hypervisor-id}/networks/{network-id}"

items[].servicesArray of strings(Services)

List of services this object belongs to. This list can be used to filter specific services in the UI.

items[].statestring

The current state of the hypervisor network.

Enum"OK""ERROR""REFRESHING"

items[].stateReasonstring<= 255 characters

Brief reason for the current state of the hypervisor network.

items[].statusstring

The current status of the hypervisor network. Status is derived and abstracted to a 'standard status' based on the status reported by the hypervisor manager.

Enum"OK""ERROR""WARNING"

offsetintegerrequired

The number of items to skip before starting to collect the result set

totalinteger

Total number of documents matching filter criteria.

Response

application/json

{
  "count": 0,
  "items": [
    { … }
  ],
  "offset": 0,
  "total": 0
}

hypervisor-tags

The hypervisor tags API enables you to get the details of the hypervisor tags in a hypervisor manager.

Operations

resource-pools

The resource pool API enables you to get the details of the hypervisor resource pools in a hypervisor manager.

Operations

virtual-machines

The virtual machines API allows the registration and management of virtual machines.

Operations

Virtualization API (1.2.0)

csp-machine-images

csp-machine-instance-types

csp-machine-instances

datastores

hypervisor-clusters

hypervisor-folders

hypervisor-hosts

hypervisor-managers

hypervisor-networks

Get a hypervisor network resource identified by {network-id}

Request

Responses

Was this helpful?

Get all network resources in a registered hypervisor manager.

Request

Responses

Was this helpful?

hypervisor-tags

resource-pools

virtual-machines