Invoke-XenSDNController

Last published : Nov 12, 2026
Invokes an operation on an SDNController object.
Related information
SDNController cmdlets

Syntax

Invoke-XenSDNController [-SDNController] <SDN_controller> -XenAction {Introduce | Forget}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenSDNController [-Ref] <XenRef[SDN_controller]> -XenAction {Introduce | Forget}
    [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]
Invoke-XenSDNController [-Uuid] <guid> -XenAction {Introduce | Forget} [-PassThru]
    [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async]
    [<CommonParameters>]

Description

Invokes an operation on an SDNController object. Use the -XenAction parameter to select which operation to perform.
Introduce: Introduce an SDN controller to the pool.
Forget: Remove the OVS manager of the pool and destroy the db record.

Parameters

-Address

IP address of the controller. Accepted when -XenAction is Introduce.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-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

-Port

TCP port of the controller. Accepted when -XenAction is Introduce.
Attribute Value
Type long
Required False
Position Named
Accepts pipeline input False

-Protocol

Protocol to connect with the controller. Accepted when -XenAction is Introduce.
Attribute Value
Type sdn_controller_protocol
Required False
Position Named
Accepts pipeline input False
Accepted values ssl, pssl, unknown

-Ref

The SDNController object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[SDN_controller]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SDNController

The SDNController object to operate on.
Attribute Value
Type SDN_controller
Required True
Position 0
Accepts pipeline input True (ByValue)

-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

-Uuid

The UUID of the SDNController to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-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

-XenAction

Selects which action to use.
Attribute Value
Type XenSDNControllerAction
Required True
Position Named
Accepts pipeline input False
Accepted values Introduce, Forget

Inputs

  • SDN_controller
  • XenRef[SDN_controller]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Introduce operation

PS> Get-XenSDNController -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenSDNController -XenAction Introduce -PassThru
Invokes the Introduce operation on an SDNController. -PassThru writes the result to the pipeline.

Example 2: Run the Introduce operation by uuid

PS> Invoke-XenSDNController -XenAction Introduce -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -PassThru
Invokes the Introduce operation on an SDNController. -Uuid is the way to be sure of exactly one object. -PassThru writes the result to the pipeline.

Example 3: Run Introduce asynchronously

PS> Invoke-XenSDNController -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Introduce -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.