APIRef_tm_vcmp_guest¶
mgmt/tm/vcmp/guest
vCMP Guest Configuration
REST Endpoints
- Collection URI
/mgmt/tm/vcmp/guest- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/vcmp/guest/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
allowedSlots |
integer | optional | read/write | Specifies the list of slots that the guest is allowed to be assigned to. | |
appService |
string | optional | read/write | The application service that the object belongs to. | |
assignedSlots |
integer | optional | read/write | The list of slots the guest was most recently allocated on. | |
bootPriority |
integer | 65535 | optional | read/write | |
coresPerSlot |
integer | 0 | optional | read/write | Specifies the number of cores that should be allocated to this guest on each slot that the guest has been assigned to. |
hostname |
string | optional | read/write | The FQDN to assign to the guest. | |
initialHotfix |
string | optional | read/write | The hotfix image to install onto any of this guest’s newly created virtual disks. | |
initialImage |
string | optional | read/write | The software image to install onto any of this guest’s newly created virtual disks. | |
managementGw |
string | optional | read/write | Management gateway IP address for the guest. | |
managementIp |
string | optional | read/write | Management IP address configuration for the guest. | |
managementNetwork |
string | bridged | optional | read/write | Accessibility of this vCMP guest’s management network. |
minSlots |
integer | 1 | optional | read/write | Specifies the minimum number of slots that the guest must be assigned to. |
preferredSlots |
integer | optional | read/write | ||
slots |
integer | 1 | optional | read/write | Specifies the number of slots the guest should be assigned to. |
sslMode |
string | shared | optional | read/write | The SSL hardware allocation mode for the guest. |
state |
string | configured | optional | read/write | Specifies the state of the guest: Configured, Provisioned, or Deployed. Each state implies the actions of all states before it. |
symUnitKey |
string | optional | read/write | The symmetric encryption key passed from the vCMP host to the guest. | |
trafficProfile |
string | optional | read/write | The network traffic profile to be applied to the guest. | |
virtualDisk |
string | optional | read/write | The filename of the virtual disk to use for this guest. |
Lists
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
vlans (net/vlan) |
array_structure | optional | read/write | The VLANs that should be passed to the host. The guest will be able to use these VLANs to pass traffic. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/capabilities |
array_structure | optional | read/write | vCMP Guest Capabilities | |
/capabilities/value |
uint64 | optional | read/write | This value is currently ignored and may be omitted. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.