Invoke-XenPool
Invokes an operation on a Pool object.
Syntax
Invoke-XenPool [-Pool] <Pool>
-XenAction {Join | JoinForce | Eject | EmergencyTransitionToMaster | EmergencyResetMaster | RecoverSlaves | CreateVLAN | ManagementReconfigure | CreateVLANFromPIF | EnableHa | DisableHa | SyncDatabase | DesignateNewMaster | HaPreventRestartsFor | HaFailoverPlanExists | HaComputeMaxHostFailuresToTolerate | HaComputeHypotheticalMaxHostFailuresToTolerate | HaComputeVmFailoverPlan | CreateNewBlob | EnableExternalAuth | DisableExternalAuth | ExternalAuthSetLdaps | DetectNonhomogeneousExternalAuth | InitializeWlb | DeconfigureWlb | SendWlbConfiguration | RetrieveWlbConfiguration | RetrieveWlbRecommendations | SendTestPost | CertificateInstall | CertificateUninstall | CertificateList | InstallCaCertificate | UninstallCaCertificate | CrlInstall | CrlUninstall | CrlList | CertificateSync | EnableTlsVerification | EnableRedoLog | DisableRedoLog | TestArchiveTarget | EnableLocalStorageCaching | DisableLocalStorageCaching | ApplyEdition | EnableSslLegacy | DisableSslLegacy | HasExtension | RotateSecret | SyncUpdates | CheckUpdateReadiness | EnableClientCertificateAuth | DisableClientCertificateAuth | ConfigureRepositoryProxy | DisableRepositoryProxy | ResetTelemetryUuid | ConfigureUpdateSync | EnableSsh | DisableSsh | InstallTrustedCertificate | UninstallTrustedCertificate | SyncTrustedCertificatesFrom}
[-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Invoke-XenPool [-Ref] <XenRef[Pool]>
-XenAction {Join | JoinForce | Eject | EmergencyTransitionToMaster | EmergencyResetMaster | RecoverSlaves | CreateVLAN | ManagementReconfigure | CreateVLANFromPIF | EnableHa | DisableHa | SyncDatabase | DesignateNewMaster | HaPreventRestartsFor | HaFailoverPlanExists | HaComputeMaxHostFailuresToTolerate | HaComputeHypotheticalMaxHostFailuresToTolerate | HaComputeVmFailoverPlan | CreateNewBlob | EnableExternalAuth | DisableExternalAuth | ExternalAuthSetLdaps | DetectNonhomogeneousExternalAuth | InitializeWlb | DeconfigureWlb | SendWlbConfiguration | RetrieveWlbConfiguration | RetrieveWlbRecommendations | SendTestPost | CertificateInstall | CertificateUninstall | CertificateList | InstallCaCertificate | UninstallCaCertificate | CrlInstall | CrlUninstall | CrlList | CertificateSync | EnableTlsVerification | EnableRedoLog | DisableRedoLog | TestArchiveTarget | EnableLocalStorageCaching | DisableLocalStorageCaching | ApplyEdition | EnableSslLegacy | DisableSslLegacy | HasExtension | RotateSecret | SyncUpdates | CheckUpdateReadiness | EnableClientCertificateAuth | DisableClientCertificateAuth | ConfigureRepositoryProxy | DisableRepositoryProxy | ResetTelemetryUuid | ConfigureUpdateSync | EnableSsh | DisableSsh | InstallTrustedCertificate | UninstallTrustedCertificate | SyncTrustedCertificatesFrom}
[-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Invoke-XenPool [-Uuid] <guid>
-XenAction {Join | JoinForce | Eject | EmergencyTransitionToMaster | EmergencyResetMaster | RecoverSlaves | CreateVLAN | ManagementReconfigure | CreateVLANFromPIF | EnableHa | DisableHa | SyncDatabase | DesignateNewMaster | HaPreventRestartsFor | HaFailoverPlanExists | HaComputeMaxHostFailuresToTolerate | HaComputeHypotheticalMaxHostFailuresToTolerate | HaComputeVmFailoverPlan | CreateNewBlob | EnableExternalAuth | DisableExternalAuth | ExternalAuthSetLdaps | DetectNonhomogeneousExternalAuth | InitializeWlb | DeconfigureWlb | SendWlbConfiguration | RetrieveWlbConfiguration | RetrieveWlbRecommendations | SendTestPost | CertificateInstall | CertificateUninstall | CertificateList | InstallCaCertificate | UninstallCaCertificate | CrlInstall | CrlUninstall | CrlList | CertificateSync | EnableTlsVerification | EnableRedoLog | DisableRedoLog | TestArchiveTarget | EnableLocalStorageCaching | DisableLocalStorageCaching | ApplyEdition | EnableSslLegacy | DisableSslLegacy | HasExtension | RotateSecret | SyncUpdates | CheckUpdateReadiness | EnableClientCertificateAuth | DisableClientCertificateAuth | ConfigureRepositoryProxy | DisableRepositoryProxy | ResetTelemetryUuid | ConfigureUpdateSync | EnableSsh | DisableSsh | InstallTrustedCertificate | UninstallTrustedCertificate | SyncTrustedCertificatesFrom}
[-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
[<CommonParameters>]
Description
Invokes an operation on a Pool object. Use the -XenAction parameter to select which operation to perform.
Join: Instruct host to join a new pool.
JoinForce: Instruct host to join a new pool.
Eject: Instruct a pool coordinator to eject a host from the pool.
EmergencyTransitionToMaster: Instruct host that's currently a supporter to transition to being coordinator.
EmergencyResetMaster: Instruct a supporter already in a pool that the coordinator has changed.
RecoverSlaves: Instruct a pool coordinator, M, to try and contact its supporters and, if supporters are in emergency mode, reset their coordinator address to M.
CreateVLAN: Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create\_VLAN\_from\_PIF instead.
ManagementReconfigure: Reconfigure the management network interface for all Hosts in the Pool.
CreateVLANFromPIF: Create a pool-wide VLAN by taking the PIF.
EnableHa: Turn on High Availability mode.
DisableHa: Turn off High Availability mode.
SyncDatabase: Forcibly synchronise the database now.
DesignateNewMaster: Perform an orderly handover of the role of coordinator to the referenced host.
HaPreventRestartsFor: When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked.
HaFailoverPlanExists: Returns true if a VM failover plan exists for up to 'n' host failures.
HaComputeMaxHostFailuresToTolerate: Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs.
HaComputeHypotheticalMaxHostFailuresToTolerate: Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs.
HaComputeVmFailoverPlan: Return a VM failover plan assuming a given subset of hosts fail.
CreateNewBlob: Create a placeholder for a named binary blob of data that is associated with this pool.
EnableExternalAuth: This call enables external authentication on all the hosts of the pool.
DisableExternalAuth: This call disables external authentication on all the hosts of the pool.
ExternalAuthSetLdaps: This call enables or disables LDAPS for external authentication on all hosts in the pool.
DetectNonhomogeneousExternalAuth: This call asynchronously detects if the external authentication configuration in any supporter is different from that in the coordinator and raises appropriate alerts.
InitializeWlb: Initializes workload balancing monitoring on this pool with the specified wlb server.
DeconfigureWlb: Permanently deconfigures workload balancing monitoring on this pool.
SendWlbConfiguration: Sets the pool optimization criteria for the workload balancing server.
RetrieveWlbConfiguration: Retrieves the pool optimization criteria from the workload balancing server.
RetrieveWlbRecommendations: Retrieves vm migrate recommendations for the pool from the workload balancing server.
SendTestPost: Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.
CertificateInstall: Install a TLS CA certificate, pool-wide. (Deprecated.)
CertificateUninstall: Remove a pool-wide TLS CA certificate. (Deprecated.)
CertificateList: List the names of all installed TLS CA certificates. (Deprecated.)
InstallCaCertificate: Install a TLS CA certificate, pool-wide. (Deprecated.)
UninstallCaCertificate: Remove a pool-wide TLS CA certificate. (Deprecated.)
CrlInstall: Install a TLS CA-issued Certificate Revocation List, pool-wide.
CrlUninstall: Remove a pool-wide TLS CA-issued Certificate Revocation List.
CrlList: List the names of all installed TLS CA-issued Certificate Revocation Lists.
CertificateSync: Copy the TLS CA certificates and CRLs of the coordinator to all supporters.
EnableTlsVerification: Enable TLS server certificate verification.
EnableRedoLog: Enable the redo log on the given SR and start using it, unless HA is enabled.
DisableRedoLog: Disable the redo log if in use, unless HA is enabled.
TestArchiveTarget: This call tests if a location is valid.
EnableLocalStorageCaching: This call attempts to enable pool-wide local storage caching.
DisableLocalStorageCaching: This call disables pool-wide local storage caching.
ApplyEdition: Apply an edition to all hosts in the pool.
EnableSslLegacy: Sets ssl\_legacy true on each host, pool coordinator last. See Host.ssl\_legacy and Host.set\_ssl\_legacy. (Removed.)
DisableSslLegacy: Sets ssl\_legacy false on each host, pool coordinator last. See Host.ssl\_legacy and Host.set\_ssl\_legacy. (Deprecated.)
HasExtension: Return true if the extension is available on the pool.
RotateSecret
SyncUpdates: Sync with the enabled repository.
CheckUpdateReadiness: Check if the pool is ready to be updated. If not, report the reasons.
EnableClientCertificateAuth: Enable client certificate authentication on the pool.
DisableClientCertificateAuth: Disable client certificate authentication on the pool.
ConfigureRepositoryProxy: Configure proxy for RPM package repositories.
DisableRepositoryProxy: Disable the proxy for RPM package repositories.
ResetTelemetryUuid: Assign a new UUID to telemetry data.
ConfigureUpdateSync: Configure periodic update synchronization to synchronize updates from a remote CDN.
EnableSsh: Enable SSH access on all hosts in the pool. It's a helper which calls host.enable\_ssh for all the hosts in the pool.
DisableSsh: Disable SSH access on all hosts in the pool. It's a helper which calls host.disable\_ssh for all the hosts in the pool.
InstallTrustedCertificate: Install a trusted TLS certificate, pool-wide.
UninstallTrustedCertificate: Uninstall a trusted TLS certificate, pool-wide.
SyncTrustedCertificatesFrom: Download trusted TLS certificates from a remote pool and install them in this pool. Certificates already present locally (matched by fingerprint and purpose) are skipped.
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 |
-AuthType
The type of authentication (for example, AD for Active Directory). Accepted when -XenAction is EnableExternalAuth.
| Attribute | Value |
|---|---|
| Type | string |
| 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 |
-Body
The Body to use. Accepted when -XenAction is SendTestPost.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ca
The trusted certificate is a root CA certificate used to verify a chain (true), or a leaf certificate used for certificate pinning (false). Accepted when -XenAction is InstallTrustedCertificate, SyncTrustedCertificatesFrom.
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Cert
The certificate in PEM format. Accepted when -XenAction is CertificateInstall, InstallCaCertificate, CrlInstall, InstallTrustedCertificate.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Certificate
The reference of the trusted certificate to be uninstalled. Accepted when -XenAction is UninstallTrustedCertificate.
| Attribute | Value |
|---|---|
| Type | XenRef[Certificate] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Config
A list of key-values containing the configuration data. Accepted when -XenAction is EnableExternalAuth, DisableExternalAuth, SendWlbConfiguration, TestArchiveTarget.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Configuration
Detailed HA configuration to apply. Accepted when -XenAction is EnableHa, HaComputeHypotheticalMaxHostFailuresToTolerate.
| Attribute | Value |
|---|---|
| Type | hashtable |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Confirm
Prompts for confirmation before running the cmdlet.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | cf |
-Device
physical interface on which to create the VLAN interface. Accepted when -XenAction is CreateVLAN.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Edition
The requested edition. Accepted when -XenAction is ApplyEdition.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-FailedHosts
The set of hosts to assume have failed. Accepted when -XenAction is HaComputeVmFailoverPlan.
| Attribute | Value |
|---|---|
| Type | List[XenRef[Host]] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-FailedVms
The set of VMs to restart. Accepted when -XenAction is HaComputeVmFailoverPlan.
| Attribute | Value |
|---|---|
| Type | List[XenRef[VM]] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Force
Force the operation even if already in the desired state. Accepted when -XenAction is ExternalAuthSetLdaps, UninstallCaCertificate, SyncUpdates.
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-HeartbeatSrs
Set of SRs to use for storage heartbeating. Accepted when -XenAction is EnableHa.
| Attribute | Value |
|---|---|
| Type | List[XenRef[SR]] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ldaps
Whether to enable or disable LDAPS. Accepted when -XenAction is ExternalAuthSetLdaps.
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-MasterAddress
The hostname of the coordinator of the pool to join. Accepted when -XenAction is Join, JoinForce, EmergencyResetMaster.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-MasterPassword
The password for the coordinator (for initial authentication). Accepted when -XenAction is Join, JoinForce.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-MasterUsername
The username of the coordinator (for initial authentication). Accepted when -XenAction is Join, JoinForce.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-MimeType
The mime type for the data. Empty string translates to application/octet-stream. Accepted when -XenAction is CreateNewBlob.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-N
The number of host failures to plan for. Accepted when -XenAction is HaFailoverPlanExists.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-NameParam
The name associated with the blob. Accepted when -XenAction is CreateNewBlob, CertificateInstall, CertificateUninstall, InstallCaCertificate, UninstallCaCertificate, CrlInstall, CrlUninstall, HasExtension, EnableClientCertificateAuth.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Network
network to which this interface should be connected. Accepted when -XenAction is CreateVLAN, ManagementReconfigure, CreateVLANFromPIF.
| Attribute | Value |
|---|---|
| Type | XenRef[Network] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-PIF
physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface. Accepted when -XenAction is CreateVLANFromPIF.
| Attribute | Value |
|---|---|
| Type | XenRef[PIF] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-PassThru
If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Password
The password of the remote pool. Accepted when -XenAction is SyncUpdates, ConfigureRepositoryProxy.
| Attribute | Value |
|---|---|
| Type | string |
| 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) |
-Port
The Port to use. Accepted when -XenAction is SendTestPost.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Public
True if the blob should be publicly available. Accepted when -XenAction is CreateNewBlob.
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Purpose
The purpose of the certificate. Accepted when -XenAction is InstallTrustedCertificate.
| Attribute | Value |
|---|---|
| Type | List[certificate_purpose] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | licensing, ldaps, unknown |
-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 |
-RemoteCertificate
The PEM-encoded TLS certificate of the remote pool's coordinator, used to verify the TLS connection to the remote pool. Accepted when -XenAction is SyncTrustedCertificatesFrom.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-RemotePool
The hostname or IP address of the coordinator of the remote pool from which the certificates are downloaded. Accepted when -XenAction is SyncTrustedCertificatesFrom.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-RemoteSession
A session obtained from the remote pool, used to authenticate the download. Accepted when -XenAction is SyncTrustedCertificatesFrom.
| Attribute | Value |
|---|---|
| Type | XenRef[Session] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-RequiresReboot
Assume that the update will require host reboots. Accepted when -XenAction is CheckUpdateReadiness.
| Attribute | Value |
|---|---|
| Type | bool |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-SR
SR to hold the redo log. Accepted when -XenAction is EnableRedoLog.
| Attribute | Value |
|---|---|
| Type | XenRef[SR] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Seconds
The number of seconds to block the restart thread for. Accepted when -XenAction is HaPreventRestartsFor.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-ServiceName
The name of the service. Accepted when -XenAction is EnableExternalAuth.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-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 |
-Token
The token for repository client authentication. Accepted when -XenAction is SyncUpdates.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-TokenId
The ID of the token. Accepted when -XenAction is SyncUpdates.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-UpdateSyncDay
The day of the week the update synchronization will happen, based on pool's local timezone. Valid values are 0 to 6, 0 being Sunday. For 'daily' schedule, the value is ignored. Accepted when -XenAction is ConfigureUpdateSync.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-UpdateSyncFrequency
The frequency at which updates are synchronized from a remote CDN: daily or weekly. Accepted when -XenAction is ConfigureUpdateSync.
| Attribute | Value |
|---|---|
| Type | update_sync_frequency |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | daily, weekly, unknown |
-Url
The URL of the proxy server. Accepted when -XenAction is ConfigureRepositoryProxy.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Username
The username of the remote pool. Accepted when -XenAction is SyncUpdates, ConfigureRepositoryProxy.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Uuid
The UUID of the Pool to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
-VLAN
VLAN tag for the new interface. Accepted when -XenAction is CreateVLAN, CreateVLANFromPIF.
| Attribute | Value |
|---|---|
| Type | long |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
| Aliases | wi |
-WlbPassword
The password used to authenticate with the wlb server. Accepted when -XenAction is InitializeWlb.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-WlbUrl
The ip address and port to use when accessing the wlb server. Accepted when -XenAction is InitializeWlb.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-WlbUsername
The username used to authenticate with the wlb server. Accepted when -XenAction is InitializeWlb.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-XenAction
Selects which action to use.
| Attribute | Value |
|---|---|
| Type | XenPoolAction |
| Required | True |
| Position | Named |
| Accepts pipeline input | False |
| Accepted values | Join, JoinForce, Eject, EmergencyTransitionToMaster, EmergencyResetMaster, RecoverSlaves, CreateVLAN, ManagementReconfigure, CreateVLANFromPIF, EnableHa, DisableHa, SyncDatabase, DesignateNewMaster, HaPreventRestartsFor, HaFailoverPlanExists, HaComputeMaxHostFailuresToTolerate, HaComputeHypotheticalMaxHostFailuresToTolerate, HaComputeVmFailoverPlan, CreateNewBlob, EnableExternalAuth, DisableExternalAuth, ExternalAuthSetLdaps, DetectNonhomogeneousExternalAuth, InitializeWlb, DeconfigureWlb, SendWlbConfiguration, RetrieveWlbConfiguration, RetrieveWlbRecommendations, SendTestPost, CertificateInstall, CertificateUninstall, CertificateList, InstallCaCertificate, UninstallCaCertificate, CrlInstall, CrlUninstall, CrlList, CertificateSync, EnableTlsVerification, EnableRedoLog, DisableRedoLog, TestArchiveTarget, EnableLocalStorageCaching, DisableLocalStorageCaching, ApplyEdition, EnableSslLegacy, DisableSslLegacy, HasExtension, RotateSecret, SyncUpdates, CheckUpdateReadiness, EnableClientCertificateAuth, DisableClientCertificateAuth, ConfigureRepositoryProxy, DisableRepositoryProxy, ResetTelemetryUuid, ConfigureUpdateSync, EnableSsh, DisableSsh, InstallTrustedCertificate, UninstallTrustedCertificate, SyncTrustedCertificatesFrom |
-XenHost
The host to eject. Accepted when -XenAction is Eject, DesignateNewMaster, SendTestPost.
| Attribute | Value |
|---|---|
| Type | XenRef[Host] |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-XenserverPassword
The password used by the wlb server to authenticate with the xenserver. Accepted when -XenAction is InitializeWlb.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-XenserverUsername
The username used by the wlb server to authenticate with the xenserver. Accepted when -XenAction is InitializeWlb.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
Inputs
-
Pool -
XenRef[Pool] -
guid
Outputs
-
System.Object
Examples
Example 1: Run the EmergencyTransitionToMaster operation
PS> Get-XenPool -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenPool -XenAction EmergencyTransitionToMaster
Invokes the EmergencyTransitionToMaster operation on a Pool.
Example 2: Rotate the pool secret
PS> Get-XenPool | Invoke-XenPool -XenAction RotateSecret
Existing sessions survive the rotation, so a script that is already connected carries on without reconnecting.
Example 3: Run the EmergencyTransitionToMaster operation by uuid
PS> Invoke-XenPool -XenAction EmergencyTransitionToMaster -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the EmergencyTransitionToMaster operation on a Pool. -Uuid is the way to be sure of exactly one object.
Related links
-
Class: Pool
-
Using the XenServer PowerShell module