Get-XenSDNControllerProperty

Last published : Nov 12, 2026
Gets a property of an SDNController object.
Related information
SDNController cmdlets

Syntax

Get-XenSDNControllerProperty [-SDNController] <SDN_controller>
    -XenProperty {Uuid | Protocol | Address | Port} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenSDNControllerProperty [-Ref] <XenRef[SDN_controller]>
    -XenProperty {Uuid | Protocol | Address | Port} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of an SDNController object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given SDN\_controller.
Protocol: Get the protocol field of the given SDN\_controller.
Address: Get the address field of the given SDN\_controller.
Port: Get the port field of the given SDN\_controller.

Parameters

-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

-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

-XenProperty

Selects which property to use.
Attribute Value
Type XenSDNControllerProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Protocol, Address, Port

Inputs

  • SDN_controller
  • XenRef[SDN_controller]

Outputs

  • System.Object

Examples

Example 1: Get the Protocol property

PS> Get-XenSDNController -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenSDNControllerProperty -XenProperty Protocol
Gets the Protocol property of an SDNController.

Example 2: Get the Address property

PS> Get-XenSDNController -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenSDNControllerProperty -XenProperty Address
Gets the Address property of an SDNController.

Example 3: Get the Port property

PS> Get-XenSDNController -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenSDNControllerProperty -XenProperty Port
Gets the Port property of an SDNController.