Class: PVS_proxy
a proxy connects a VM/VIF with a PVS site
| Published in: | XenServer 7.1 (ely) | |
Enums
pvs_proxy_status
| Values: | stopped | The proxy is not currently running |
| initialised | The proxy is setup but has not yet cached anything |
| caching | The proxy is currently caching data |
| incompatible_write_cache_mode | The PVS device is configured to use an incompatible write-cache mode |
| incompatible_protocol_version | The PVS protocol in use is not compatible with the PVS proxy |
Fields
bool
currently_attached
[RO/runtime]
true = VM is currently proxied
| Default value: | false |
| Published in: | XenServer 7.1 (ely) | |
PVS_site ref
site
[RO/constructor]
PVS site this proxy is part of
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.1 (ely) | |
enum pvs_proxy_status
status
[RO/runtime]
The run-time status of the proxy
| Default value: | stopped |
| Published in: | XenServer 7.1 (ely) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 7.1 (ely) | |
VIF ref
VIF
[RO/constructor]
VIF of the VM using the proxy
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.1 (ely) | |
Messages
PVS_proxy ref
create
(session ref, PVS_site ref, VIF ref)
Configure a VM/VIF to use a PVS proxy
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref site | PVS site that we proxy for |
| VIF ref VIF | VIF for the VM that needs to be proxied |
| Minimum role: | pool-operator |
| Result: | The reference of the created PVS proxy |
| Published in: | XenServer 7.1 (ely) | |
void
destroy
(session ref, PVS_proxy ref)
remove (or switch off) a PVS proxy for this VM
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | this PVS proxy |
| Minimum role: | pool-operator |
| Published in: | XenServer 7.1 (ely) | |
PVS_proxy ref set
get_all
(session ref)
Return a list of all the PVS_proxys known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 7.1 (ely) | |
(PVS_proxy ref → PVS_proxy record) map
get_all_records
(session ref)
Return a map of PVS_proxy references to PVS_proxy records for all PVS_proxys known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 7.1 (ely) | |
PVS_proxy ref
get_by_uuid
(session ref, string)
Get a reference to the PVS_proxy instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 7.1 (ely) | |
bool
get_currently_attached
(session ref, PVS_proxy ref)
Get the currently_attached field of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
PVS_proxy record
get_record
(session ref, PVS_proxy ref)
Get a record containing the current state of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 7.1 (ely) | |
PVS_site ref
get_site
(session ref, PVS_proxy ref)
Get the site field of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
enum pvs_proxy_status
get_status
(session ref, PVS_proxy ref)
Get the status field of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
string
get_uuid
(session ref, PVS_proxy ref)
Get the uuid field of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
VIF ref
get_VIF
(session ref, PVS_proxy ref)
Get the VIF field of the given PVS_proxy.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_proxy ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |