Class: PVS_site
machines serving blocks of data for provisioning VMs
| Published in: | XenServer 7.1 (ely) | |
Fields
PVS_cache_storage ref set
cache_storage
[RO/runtime]
The SR used by PVS proxy for the cache
| Default value: | {} |
| Published in: | XenServer 7.1 (ely) | |
string
name_description
[RW]
a notes field containing human-readable description
| Default value: | "" |
| Published in: | XenServer 7.1 (ely) | |
string
name_label
[RW]
a human-readable name
| Default value: | "" |
| Published in: | XenServer 7.1 (ely) | |
PVS_proxy ref set
proxies
[RO/runtime]
The set of proxies associated with the site
| Published in: | XenServer 7.1 (ely) | |
string
PVS_uuid
[RO/constructor]
Unique identifier of the PVS site, as configured in PVS
| Default value: | "" |
| Published in: | XenServer 7.1 (ely) | |
PVS_server ref set
servers
[RO/runtime]
The set of PVS servers in the site
| Published in: | XenServer 7.1 (ely) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 7.1 (ely) | |
Messages
void
forget
(session ref, PVS_site ref)
Remove a site's meta data
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | this PVS site |
| Minimum role: | pool-operator |
| Errors: | PVS_SITE_CONTAINS_RUNNING_PROXIES | The PVS site contains running proxies. |
| PVS_SITE_CONTAINS_SERVERS | The PVS site contains servers and cannot be forgotten. |
| Published in: | XenServer 7.1 (ely) | |
PVS_site ref set
get_all
(session ref)
Return a list of all the PVS_sites 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_site ref → PVS_site record) map
get_all_records
(session ref)
Return a map of PVS_site references to PVS_site records for all PVS_sites 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_site ref set
get_by_name_label
(session ref, string)
Get all the PVS_site instances with the given label.
| Parameters: | session ref session_id | Reference to a valid session |
| string label | label of object to return |
| Minimum role: | read-only |
| Result: | references to objects with matching names |
| Published in: | XenServer 7.1 (ely) | |
PVS_site ref
get_by_uuid
(session ref, string)
Get a reference to the PVS_site 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) | |
PVS_cache_storage ref set
get_cache_storage
(session ref, PVS_site ref)
Get the cache_storage field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
string
get_name_description
(session ref, PVS_site ref)
Get the name/description field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
string
get_name_label
(session ref, PVS_site ref)
Get the name/label field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
PVS_proxy ref set
get_proxies
(session ref, PVS_site ref)
Get the proxies field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
string
get_PVS_uuid
(session ref, PVS_site ref)
Get the PVS_uuid field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
PVS_site record
get_record
(session ref, PVS_site ref)
Get a record containing the current state of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 7.1 (ely) | |
PVS_server ref set
get_servers
(session ref, PVS_site ref)
Get the servers field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site 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_site ref)
Get the uuid field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.1 (ely) | |
PVS_site ref
introduce
(session ref, string, string, string)
Introduce new PVS site
| Parameters: | session ref session_id | Reference to a valid session |
| string name_label | name of the PVS site |
| string name_description | description of the PVS site |
| string PVS_uuid | unique identifier of the PVS site |
| Minimum role: | pool-operator |
| Result: | the new PVS site |
| Published in: | XenServer 7.1 (ely) | |
void
set_name_description
(session ref, PVS_site ref, string)
Set the name/description field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 7.1 (ely) | |
void
set_name_label
(session ref, PVS_site ref, string)
Set the name/label field of the given PVS_site.
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 7.1 (ely) | |
void
set_PVS_uuid
(session ref, PVS_site ref, string)
Update the PVS UUID of the PVS site
| Parameters: | session ref session_id | Reference to a valid session |
| PVS_site ref self | this PVS site |
| string value | PVS UUID to be used |
| Minimum role: | pool-operator |
| Published in: | XenServer 7.1 (ely) | |