New-PASRequestObject
New-PASRequestObject
SYNOPSIS
Creates hashtable structured to be used as input for account access request operations
SYNTAX
ConnectionParams (Default)
New-PASRequestObject [-AccountId <String>] [-Reason <String>] [-TicketingSystemName <String>]
[-TicketID <String>] [-MultipleAccessRequired <Boolean>] [-FromDate <DateTime>] [-ToDate <DateTime>]
[-AdditionalInfo <Hashtable>] [-UseConnect <Boolean>] [-ConnectionComponent <String>]
[-AllowMappingLocalDrives <String>] [-AllowConnectToConsole <String>] [-RedirectSmartCards <String>]
[-PSMRemoteMachine <String>] [-LogonDomain <String>] [-AllowSelectHTML5 <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
ManualParams
New-PASRequestObject [-AccountId <String>] [-Reason <String>] [-TicketingSystemName <String>]
[-TicketID <String>] [-MultipleAccessRequired <Boolean>] [-FromDate <DateTime>] [-ToDate <DateTime>]
[-AdditionalInfo <Hashtable>] [-UseConnect <Boolean>] [-ConnectionComponent <String>]
[-ConnectionParams <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Provide parameter values to return hashtable structured to be used as input for account access request operations.
EXAMPLES
Example 1
New-PASRequest -AccountId 123_4 -TicketingSystemName SomeITSM -TicketID 4321 -FromDate (Get-date) -ToDate $((Get-Date).AddHours(4)) -PSMRemoteMachine SomeServer
Returns hashtable structured to be used as input for account access request operations
PARAMETERS
-AccountId
The ID of the account to access
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Reason
The reason why the account will be accessed
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TicketingSystemName
The name of the Ticketing system specified in the request
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TicketID
The Ticket ID given by the ticketing system.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-MultipleAccessRequired
Whether the request is for multiple accesses
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FromDate
If the request is for a timeframe, the time from when the user wants to access the account.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ToDate
If the request is for a timeframe, the time until the user wants to access the account.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AdditionalInfo
Additional information included in the request
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-UseConnect
Whether or not the request is for connection through the PSM.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConnectionComponent
If the connection is through PSM, the name of the connection component to connect with, as defined in the configuration.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AllowMappingLocalDrives
Whether or not to redirect their local hard drives to the remote server.
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AllowConnectToConsole
Whether or not to connect to the administrative console of the remote machine.
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RedirectSmartCards
Whether or not to redirect Smart Card so that the certificate stored on the card can be accessed on the target
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PSMRemoteMachine
Address of the remote machine to connect to.
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LogonDomain
The NetBIOS domain name of the account being used.
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AllowSelectHTML5
Specify which connection method, HTML5-based or RDP-file, to use when connecting to the remote server
Type: String
Parameter Sets: ConnectionParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConnectionParams
A list of parameters required to perform the connection, as defined in each connection component configuration
Type: Hashtable
Parameter Sets: ManualParams
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
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.