Get-XenPoolProperty
Gets a property of a Pool object.
Syntax
Get-XenPoolProperty [-Pool] <Pool>
-XenProperty {Uuid | NameLabel | NameDescription | Master | DefaultSR | SuspendImageSR | CrashDumpSR | OtherConfig | HaEnabled | HaConfiguration | HaStatefiles | HaHostFailuresToTolerate | HaPlanExistsFor | HaAllowOvercommit | HaOvercommitted | Blobs | Tags | GuiConfig | HealthCheckConfig | WlbUrl | WlbUsername | WlbEnabled | WlbVerifyCert | RedoLogEnabled | RedoLogVdi | VswitchController | Restrictions | MetadataVDIs | HaClusterStack | AllowedOperations | CurrentOperations | GuestAgentConfig | CpuInfo | PolicyNoVendorDevice | LivePatchingDisabled | IgmpSnoopingEnabled | UefiCertificates | CustomUefiCertificates | IsPsrPending | TlsVerificationEnabled | Repositories | ClientCertificateAuthEnabled | ClientCertificateAuthName | RepositoryProxyUrl | RepositoryProxyUsername | RepositoryProxyPassword | MigrationCompression | CoordinatorBias | LocalAuthMaxThreads | ExtAuthMaxThreads | ExtAuthCacheEnabled | ExtAuthCacheSize | ExtAuthCacheExpiry | TelemetryUuid | TelemetryFrequency | TelemetryNextCollection | LastUpdateSync | UpdateSyncFrequency | UpdateSyncDay | UpdateSyncEnabled | Recommendations | LicenseServer | HaRebootVmOnInternalShutdown | LimitConsoleSessions | VmConsoleIdleTimeout | AutoUpdateVmSecurebootCertificates | LldpEnabled | LldpMulticastAddress | LicenseState | GuestSecurebootReadiness}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Get-XenPoolProperty [-Ref] <XenRef[Pool]>
-XenProperty {Uuid | NameLabel | NameDescription | Master | DefaultSR | SuspendImageSR | CrashDumpSR | OtherConfig | HaEnabled | HaConfiguration | HaStatefiles | HaHostFailuresToTolerate | HaPlanExistsFor | HaAllowOvercommit | HaOvercommitted | Blobs | Tags | GuiConfig | HealthCheckConfig | WlbUrl | WlbUsername | WlbEnabled | WlbVerifyCert | RedoLogEnabled | RedoLogVdi | VswitchController | Restrictions | MetadataVDIs | HaClusterStack | AllowedOperations | CurrentOperations | GuestAgentConfig | CpuInfo | PolicyNoVendorDevice | LivePatchingDisabled | IgmpSnoopingEnabled | UefiCertificates | CustomUefiCertificates | IsPsrPending | TlsVerificationEnabled | Repositories | ClientCertificateAuthEnabled | ClientCertificateAuthName | RepositoryProxyUrl | RepositoryProxyUsername | RepositoryProxyPassword | MigrationCompression | CoordinatorBias | LocalAuthMaxThreads | ExtAuthMaxThreads | ExtAuthCacheEnabled | ExtAuthCacheSize | ExtAuthCacheExpiry | TelemetryUuid | TelemetryFrequency | TelemetryNextCollection | LastUpdateSync | UpdateSyncFrequency | UpdateSyncDay | UpdateSyncEnabled | Recommendations | LicenseServer | HaRebootVmOnInternalShutdown | LimitConsoleSessions | VmConsoleIdleTimeout | AutoUpdateVmSecurebootCertificates | LldpEnabled | LldpMulticastAddress | LicenseState | GuestSecurebootReadiness}
[-BestEffort] [-SessionOpaqueRef <string>] [-Async] [<CommonParameters>]
Description
Gets a specified property of a Pool object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given pool.
NameLabel: Get the name\_label field of the given pool.
NameDescription: Get the name\_description field of the given pool.
Master: Get the master field of the given pool.
DefaultSR: Get the default\_SR field of the given pool.
SuspendImageSR: Get the suspend\_image\_SR field of the given pool.
CrashDumpSR: Get the crash\_dump\_SR field of the given pool.
OtherConfig: Get the other\_config field of the given pool.
HaEnabled: Get the ha\_enabled field of the given pool.
HaConfiguration: Get the ha\_configuration field of the given pool.
HaStatefiles: Get the ha\_statefiles field of the given pool.
HaHostFailuresToTolerate: Get the ha\_host\_failures\_to\_tolerate field of the given pool.
HaPlanExistsFor: Get the ha\_plan\_exists\_for field of the given pool.
HaAllowOvercommit: Get the ha\_allow\_overcommit field of the given pool.
HaOvercommitted: Get the ha\_overcommitted field of the given pool.
Blobs: Get the blobs field of the given pool.
Tags: Get the tags field of the given pool.
GuiConfig: Get the gui\_config field of the given pool.
HealthCheckConfig: Get the health\_check\_config field of the given pool.
WlbUrl: Get the wlb\_url field of the given pool.
WlbUsername: Get the wlb\_username field of the given pool.
WlbEnabled: Get the wlb\_enabled field of the given pool.
WlbVerifyCert: Get the wlb\_verify\_cert field of the given pool. (Deprecated.)
RedoLogEnabled: Get the redo\_log\_enabled field of the given pool.
RedoLogVdi: Get the redo\_log\_vdi field of the given pool.
VswitchController: Get the vswitch\_controller field of the given pool. (Deprecated.)
Restrictions: Get the restrictions field of the given pool.
MetadataVDIs: Get the metadata\_VDIs field of the given pool.
HaClusterStack: Get the ha\_cluster\_stack field of the given pool.
AllowedOperations: Get the allowed\_operations field of the given pool.
CurrentOperations: Get the current\_operations field of the given pool.
GuestAgentConfig: Get the guest\_agent\_config field of the given pool.
CpuInfo: Get the cpu\_info field of the given pool.
PolicyNoVendorDevice: Get the policy\_no\_vendor\_device field of the given pool. (Deprecated.)
LivePatchingDisabled: Get the live\_patching\_disabled field of the given pool.
IgmpSnoopingEnabled: Get the igmp\_snooping\_enabled field of the given pool.
UefiCertificates: Get the uefi\_certificates field of the given pool.
CustomUefiCertificates: Get the custom\_uefi\_certificates field of the given pool.
IsPsrPending: Get the is\_psr\_pending field of the given pool.
TlsVerificationEnabled: Get the tls\_verification\_enabled field of the given pool.
Repositories: Get the repositories field of the given pool.
ClientCertificateAuthEnabled: Get the client\_certificate\_auth\_enabled field of the given pool.
ClientCertificateAuthName: Get the client\_certificate\_auth\_name field of the given pool.
RepositoryProxyUrl: Get the repository\_proxy\_url field of the given pool.
RepositoryProxyUsername: Get the repository\_proxy\_username field of the given pool.
RepositoryProxyPassword: Get the repository\_proxy\_password field of the given pool.
MigrationCompression: Get the migration\_compression field of the given pool.
CoordinatorBias: Get the coordinator\_bias field of the given pool.
LocalAuthMaxThreads: Get the local\_auth\_max\_threads field of the given pool.
ExtAuthMaxThreads: Get the ext\_auth\_max\_threads field of the given pool.
ExtAuthCacheEnabled: Get the ext\_auth\_cache\_enabled field of the given pool.
ExtAuthCacheSize: Get the ext\_auth\_cache\_size field of the given pool.
ExtAuthCacheExpiry: Get the ext\_auth\_cache\_expiry field of the given pool.
TelemetryUuid: Get the telemetry\_uuid field of the given pool.
TelemetryFrequency: Get the telemetry\_frequency field of the given pool.
TelemetryNextCollection: Get the telemetry\_next\_collection field of the given pool.
LastUpdateSync: Get the last\_update\_sync field of the given pool.
UpdateSyncFrequency: Get the update\_sync\_frequency field of the given pool.
UpdateSyncDay: Get the update\_sync\_day field of the given pool.
UpdateSyncEnabled: Get the update\_sync\_enabled field of the given pool.
Recommendations: Get the recommendations field of the given pool.
LicenseServer: Get the license\_server field of the given pool.
HaRebootVmOnInternalShutdown: Get the ha\_reboot\_vm\_on\_internal\_shutdown field of the given pool.
LimitConsoleSessions: Get the limit\_console\_sessions field of the given pool.
VmConsoleIdleTimeout: Get the vm\_console\_idle\_timeout field of the given pool.
AutoUpdateVmSecurebootCertificates: Get the auto\_update\_vm\_secureboot\_certificates field of the given pool.
LldpEnabled: Get the lldp\_enabled field of the given pool.
LldpMulticastAddress: Get the lldp\_multicast\_address field of the given pool.
LicenseState: This call returns the license state for the pool.
GuestSecurebootReadiness
Parameters
-Async
If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-BestEffort
If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Pool
The Pool object to operate on.
| Attribute | Value |
|---|---|
| Type | Pool |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByValue) |
-Ref
The Pool object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Pool] |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SessionOpaqueRef
The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-XenProperty
Selects which property to use.
| Attribute | Value |
|---|---|
| Type | XenPoolProperty |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Uuid, NameLabel, NameDescription, Master, DefaultSR, SuspendImageSR, CrashDumpSR, OtherConfig, HaEnabled, HaConfiguration, HaStatefiles, HaHostFailuresToTolerate, HaPlanExistsFor, HaAllowOvercommit, HaOvercommitted, Blobs, Tags, GuiConfig, HealthCheckConfig, WlbUrl, WlbUsername, WlbEnabled, WlbVerifyCert, RedoLogEnabled, RedoLogVdi, VswitchController, Restrictions, MetadataVDIs, HaClusterStack, AllowedOperations, CurrentOperations, GuestAgentConfig, CpuInfo, PolicyNoVendorDevice, LivePatchingDisabled, IgmpSnoopingEnabled, UefiCertificates, CustomUefiCertificates, IsPsrPending, TlsVerificationEnabled, Repositories, ClientCertificateAuthEnabled, ClientCertificateAuthName, RepositoryProxyUrl, RepositoryProxyUsername, RepositoryProxyPassword, MigrationCompression, CoordinatorBias, LocalAuthMaxThreads, ExtAuthMaxThreads, ExtAuthCacheEnabled, ExtAuthCacheSize, ExtAuthCacheExpiry, TelemetryUuid, TelemetryFrequency, TelemetryNextCollection, LastUpdateSync, UpdateSyncFrequency, UpdateSyncDay, UpdateSyncEnabled, Recommendations, LicenseServer, HaRebootVmOnInternalShutdown, LimitConsoleSessions, VmConsoleIdleTimeout, AutoUpdateVmSecurebootCertificates, LldpEnabled, LldpMulticastAddress, LicenseState, GuestSecurebootReadiness |
Inputs
-
Pool -
XenRef[Pool]
Outputs
-
System.Object
Examples
Example 1: Get the Master property
PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPoolProperty -XenProperty Master
Gets the Master property of a Pool.
Example 2: Get the DefaultSR property
PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPoolProperty -XenProperty DefaultSR
Gets the DefaultSR property of a Pool.
Example 3: Get the SuspendImageSR property
PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPoolProperty -XenProperty SuspendImageSR
Gets the SuspendImageSR property of a Pool.
Related links
-
Class: Pool
-
Using the XenServer PowerShell module