Class: secret
A secret
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
Fields
(string → string) map
other_config
[RW]
other_config
| Default value: | {} |
| Published in: | XenServer 4.0 (rio) | other_config |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
value
[RW]
the secret
| Published in: | XenServer 4.0 (rio) | the secret |
Messages
void
add_to_other_config
(session ref, secret ref, string, string)
Add the given key-value pair to the other_config field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| string key | Key to add |
| string value | Value to add |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.0 (rio) | other_config |
secret ref
create
(session ref, secret record)
Create a new secret instance, and return its handle.
The constructor args are: value*, other_config (* = non-optional).
| Parameters: | session ref session_id | Reference to a valid session |
| secret record args | All constructor arguments |
| Minimum role: | pool-operator |
| Result: | reference to the newly created object |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
void
destroy
(session ref, secret ref)
Destroy the specified secret instance.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| Minimum role: | pool-operator |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
secret ref set
get_all
(session ref)
Return a list of all the secrets known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator |
| Result: | references to all objects |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
(secret ref → secret record) map
get_all_records
(session ref)
Return a map of secret references to secret records for all secrets known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | pool-operator |
| Result: | records of all objects |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
secret ref
get_by_uuid
(session ref, string)
Get a reference to the secret instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | pool-operator |
| Result: | reference to the object |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
(string → string) map
get_other_config
(session ref, secret ref)
Get the other_config field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | other_config |
secret record
get_record
(session ref, secret ref)
Get a record containing the current state of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| Minimum role: | pool-operator |
| Result: | all fields from the object |
| Published in: | XenServer 5.6 (midnight-ride) | A secret |
string
get_uuid
(session ref, secret ref)
Get the uuid field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| Minimum role: | pool-operator |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | Unique identifier/object reference |
string
get_value
(session ref, secret ref)
Get the value field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| Minimum role: | pool-operator |
| Result: | value of the field |
| Published in: | XenServer 4.0 (rio) | the secret |
void
remove_from_other_config
(session ref, secret ref, string)
Remove the given key and its corresponding value from the other_config field of the given secret. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.0 (rio) | other_config |
void
set_other_config
(session ref, secret ref, (string → string) map)
Set the other_config field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.0 (rio) | other_config |
void
set_value
(session ref, secret ref, string)
Set the value field of the given secret.
| Parameters: | session ref session_id | Reference to a valid session |
| secret ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 4.0 (rio) | the secret |