Class: PVS_server
individual machine serving provisioning (block) data
Fields for class: PVS_server
| Field | Type | Qualifier | Description |
|---|---|---|---|
addresses |
string set |
RO/constructor | IPv4 addresses of this server |
first_port |
int |
RO/constructor | First UDP port accepted by this server |
last_port |
int |
RO/constructor | Last UDP port accepted by this server |
site |
PVS_site ref |
RO/constructor | PVS site this server is part of |
uuid |
string |
RO/runtime | Unique identifier/object reference |
RPCs associated with class: PVS_server
RPC name: forget
Overview:
forget a PVS server
Signature:
void forget (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
this PVS server |
Minimum Role: pool-operator
Return Type: void
RPC name: get_addresses
Overview:
Get the addresses field of the given PVS_server.
Signature:
string set get_addresses (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string set
value of the field
RPC name: get_all
Overview:
Return a list of all the PVS_servers known to the system.
Signature:
PVS_server ref set get_all (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: PVS_server ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of PVS_server references to PVS_server records for all PVS_servers known to the system.
Signature:
(PVS_server ref -> PVS_server record) map get_all_records (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: (PVS_server ref -> PVS_server record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the PVS_server instance with the specified UUID.
Signature:
PVS_server ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
uuid |
UUID of object to return |
Minimum Role: read-only
Return Type: PVS_server ref
reference to the object
RPC name: get_first_port
Overview:
Get the first_port field of the given PVS_server.
Signature:
int get_first_port (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: int
value of the field
RPC name: get_last_port
Overview:
Get the last_port field of the given PVS_server.
Signature:
int get_last_port (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: int
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given PVS_server.
Signature:
PVS_server record get_record (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PVS_server record
all fields from the object
RPC name: get_site
Overview:
Get the site field of the given PVS_server.
Signature:
PVS_site ref get_site (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: PVS_site ref
value of the field
RPC name: get_uuid
Overview:
Get the uuid field of the given PVS_server.
Signature:
string get_uuid (session ref session_ref, PVS_server ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
PVS_server ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: introduce
Overview:
introduce new PVS server
Signature:
PVS_server ref introduce (session ref session_ref, string set addresses, int first_port, int last_port, PVS_site ref site)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string set |
addresses |
IPv4/IPv6 addresses of the server |
int |
first_port |
first UDP port accepted by this server |
int |
last_port |
last UDP port accepted by this server |
PVS_site ref |
site |
PVS site this server is a part of |
Minimum Role: pool-operator
Return Type: PVS_server ref
the new PVS server