Get-UMSDeviceDirectory.md

external help file	Module Name	online version	schema
PSIGEL-help.xml	PSIGEL	https://github.com/IGEL-Community/PSIGEL/blob/master/Docs/Reference/Get-UMSDeviceDirectory.md	2.0.0

Get-UMSDeviceDirectory

SYNOPSIS

Gets information on a device directory.

SYNTAX

All (Default)

Get-UMSDeviceDirectory [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
 [[-SecurityProtocol] <String[]>] [-WebSession] <Object> [[-Filter] <String>] [<CommonParameters>]

Id

Get-UMSDeviceDirectory [-Computername] <String> [[-TCPPort] <Int32>] [[-ApiVersion] <Int32>]
 [[-SecurityProtocol] <String[]>] [-WebSession] <Object> [[-Filter] <String>] [[-Id] <Int32>]
 [<CommonParameters>]

DESCRIPTION

Gets information on a device directory via API.

EXAMPLES

Example 1

Get all device directories:

Get-UMSDeviceDirectory -ComputerName 'igelrmserver' -WebSession $WebSession

Id         : 71
Name       : IGELOS
ParentId   : -1
MovedToBin : False
ObjectType : tcdirectory

Id         : 664
Name       : Augsburg
ParentId   : 71
MovedToBin : False
ObjectType : tcdirectory

Id         : 665
Name       : Bremen
ParentId   : 71
MovedToBin : False
ObjectType : tcdirectory

Example 2

Get device directory with ID 71, including its children directories:

71 | Get-UMSDeviceDirectory -ComputerName 'igelrmserver' -WebSession $WebSession -Filter children

Id                : 71
Name              : IGELOS
ParentId          : -1
MovedToBin        : False
ObjectType        : tcdirectory
DirectoryChildren : {@{ObjectType=tcdirectory; Id=664}, @{ObjectType=tcdirectory; Id=665}}

PARAMETERS

-ApiVersion

API Version to use

Type: Int32
Parameter Sets: (All)
Aliases:
Accepted values: 3

Required: False
Position: Benannt
Default value: 3
Accept pipeline input: False
Accept wildcard characters: False

-Computername

Computername of the UMS Server

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Optional filter

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: children

Required: False
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

ID of the device directory

Type: Int32
Parameter Sets: Id
Aliases:

Required: False
Position: Benannt
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SecurityProtocol

Set SSL/TLS protocol

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: Tls12, Tls11, Tls, Ssl3

Required: False
Position: Benannt
Default value: Tls12
Accept pipeline input: False
Accept wildcard characters: False

-TCPPort

TCP Port API

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Benannt
Default value: 8443
Accept pipeline input: False
Accept wildcard characters: False

-WebSession

Websession Cookie

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: Benannt
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Int32

OUTPUTS

System.Object

NOTES

RELATED LINKS