DISCLAIMER

This utility is currently in beta version and is provided for testing and evaluation purposes only. While I have made every effort to ensure its accuracy and functionality, it may still contain bugs, inaccuracies, or incomplete features

Please use this utility as a guide and not as a definitive source of information. I do not guarantee the accuracy, completeness, or reliability of the results generated by this tool. Please verify the output independently. Thank you for your understanding and cooperation!

Step1 - Authentication:

Authentication Type:

CyberArk
LDAP
Radius
Windows
Saml
ISPSS CyberArk
ISPSS Oauth

Enter Values:

PVWA:

Enter Values:

PVWA:

IdentityURL:

Enter Values:

PVWA:

IDPLogin:

Extra Options:

HideAscii
Removes the VPasModule logo from appearing in the output

NoSSL
API calls will be made via HTTP not HTTPS (Not Recommended!)

InitiateCookie
Initiate a cookie variable that will be included in the header if PVWA loadbalancer is not set up for stickiness or persistency

TextRecorder
Enable Text Recording which will log out every API command, return value, and general information

HideWarningsHide any warning outputs from the console during the API session

Step2 - Select Command:

Select Command:

Add-VPASAccount

Add-VPASAccountGroup

Add-VPASAccountRequest

Add-VPASAccountToAccountGroup

Add-VPASAllowedIP

Add-VPASAllowedReferrer

Add-VPASApplication

Add-VPASApplicationAuthentication

Add-VPASAuthenticationMethod

Add-VPASBulkAccounts

Add-VPASBulkSafeMembers

Add-VPASBulkSafes

Add-VPASEPVGroup

Add-VPASEPVUser

Add-VPASIdentityRole

Add-VPASIdentitySecurityQuestionAdmin

Add-VPASIdentityUserSecurityQuestions

Add-VPASMemberEPVGroup

Add-VPASSafe

Add-VPASSafeMember

Approve-VPASIncomingRequest

Confirm-VPASBulkFile

Copy-VPASGroupPlatform

Copy-VPASPlatform

Copy-VPASRotationalPlatform

Copy-VPASUsagePlatform

Deny-VPASIncomingRequest

Disable-VPASEPVUser

Disable-VPASGroupPlatform

Disable-VPASPlatform

Disable-VPASRotationalPlatform

Enable-VPASEPVUser

Enable-VPASGroupPlatform

Enable-VPASPlatform

Enable-VPASRotationalPlatform

Export-VPASPlatform

Get-VPASAccountActivity

Get-VPASAccountDetails

Get-VPASAccountGroupMembers

Get-VPASAccountGroups

Get-VPASAccountPrivateSSHKey

Get-VPASAccountRequestDetails

Get-VPASActiveSessionActivities

Get-VPASActiveSessionProperties

Get-VPASActiveSessions

Get-VPASAllAccountRequests

Get-VPASAllAccounts

Get-VPASAllActiveSessions

Get-VPASAllApplications

Get-VPASAllConnectionComponents

Get-VPASAllDirectories

Get-VPASAllDiscoveredAccounts

Get-VPASAllEPVGroups

Get-VPASAllEPVUsers

Get-VPASAllGroupPlatforms

Get-VPASAllIncomingRequests

Get-VPASAllowedIPs

Get-VPASAllowedReferrer

Get-VPASAllPlatforms

Get-VPASAllPSMServers

Get-VPASAllPSMSessions

Get-VPASAllRotationalPlatforms

Get-VPASAllSafes

Get-VPASAllTargetPlatforms

Get-VPASAllUsagePlatforms

Get-VPASApplicationAuthentications

Get-VPASApplicationDetails

Get-VPASAuthenticationMethods

Get-VPASBulkTemplateFiles

Get-VPASCMAllComponents

Get-VPASCMAllConnectorComponents

Get-VPASCMAllConnectorPools

Get-VPASCMAllConnectors

Get-VPASCMComponentLogList

Get-VPASCMComponentLogs

Get-VPASCMConnectorComponentDetails

Get-VPASCMConnectorDetails

Get-VPASCMConnectorPoolDetails

Get-VPASCMConnectors

Get-VPASCurrentEPVUserDetails

Get-VPASDirectoryDetails

Get-VPASDirectoryMappingDetails

Get-VPASDirectoryMappings

Get-VPASDiscoveredAccounts

Get-VPASDiscoveredAccountsDependencies

Get-VPASDPAAllPolicies

Get-VPASDPAAllStrongAccounts

Get-VPASDPAAllStrongAccountSets

Get-VPASDPAPolicies

Get-VPASDPAPolicyDetails

Get-VPASDPASettings

Get-VPASDPAStrongAccountDetails

Get-VPASDPAStrongAccounts

Get-VPASEPVGroupDetails

Get-VPASEPVUserDetails

Get-VPASEPVUserDetailsSearch

Get-VPASEPVUserTypes

Get-VPASGroupPlatformDetails

Get-VPASIdentityAdminSecurityQuestion

Get-VPASIdentityAllAdminSecurityQuestions

Get-VPASIdentityAllRoles

Get-VPASIdentityAllUsers

Get-VPASIdentityCurrentUserDetails

Get-VPASIdentityCurrentUserSecurityQuestions

Get-VPASIdentityRoleDetails

Get-VPASIdentityRoles

Get-VPASIdentityTenantDetails

Get-VPASIdentityUserDetails

Get-VPASIdentityUserSecurityQuestions

Get-VPASIncomingRequestDetails

Get-VPASPasswordHistory

Get-VPASPasswordValue

Get-VPASPlatformDetails

Get-VPASPlatformDetailsSearch

Get-VPASPSMSessionActivities

Get-VPASPSMSessionDetails

Get-VPASPSMSessionProperties

Get-VPASPSMSessions

Get-VPASPSMSettingsByPlatformID

Get-VPASRotationalPlatformDetails

Get-VPASSafeDetails

Get-VPASSafeMembers

Get-VPASSafeMemberSearch

Get-VPASSafes

Get-VPASSafesByPlatformID

Get-VPASSpecificAuthenticationMethod

Get-VPASSQLAccounts

Get-VPASSQLPlatforms

Get-VPASSQLSafes

Get-VPASSystemComponents

Get-VPASSystemHealth

Get-VPASUsagePlatformDetails

Get-VPASVaultDetails

Get-VPASVaultVersion

Import-VPASConnectionComponent

Import-VPASPlatform

Invoke-VPASAccountPasswordAction

Invoke-VPASActivePSMSessionAction

Invoke-VPASAuditSafeTest

Invoke-VPASCentralCredentialProvider

Invoke-VPASCredentialProvider

Invoke-VPASMetricsAccounts

Invoke-VPASMetricsCPM

Invoke-VPASMetricsPlatforms

Invoke-VPASMetricsProviders

Invoke-VPASMetricsPSM

Invoke-VPASQuery

Invoke-VPASReporting

Invoke-VPASUserLicenseReport

New-VPASDPASetupScript

New-VPASIdentityGenerateUserPassword

New-VPASPSMSession

Remove-VPASAccount

Remove-VPASAccountFromAccountGroup

Remove-VPASAccountRequest

Remove-VPASAllDiscoveredAccounts

Remove-VPASApplication

Remove-VPASApplicationAuthentication

Remove-VPASAuthenticationMethod

Remove-VPASDirectory

Remove-VPASDPAPolicy

Remove-VPASDPAStrongAccount

Remove-VPASEPVGroup

Remove-VPASEPVUser

Remove-VPASGroupPlatform

Remove-VPASIdentityAdminSecurityQuestion

Remove-VPASIdentityRole

Remove-VPASLinkedAccount

Remove-VPASMemberEPVGroup

Remove-VPASPlatform

Remove-VPASRotationalPlatform

Remove-VPASSafe

Remove-VPASSafeMember

Remove-VPASToken

Remove-VPASUsagePlatform

Reset-VPASEPVUserPassword

Reset-VPASIdentityUserSecurityQuestions

Set-VPASAuditSafeTest

Set-VPASIdentityUserState

Set-VPASIdentityUserStatus

Set-VPASLinkedAccount

Set-VPASSQLConnectionDetails

Test-VPASIdentityUserLocked

Test-VPASSQLConnectionDetails

Unlock-VPASExclusiveAccount

Update-VPASAccountFields

Update-VPASAuthenticationMethod

Update-VPASEPVGroup

Update-VPASEPVUser

Update-VPASIdentityCurrentUserPassword

Update-VPASIdentityRole

Update-VPASPSMSettingsByPlatformID

Update-VPASSafe

Update-VPASSafeMember

Watch-VPASActivePSMSession

Add-VPASAccount : Required Parameters

platformID:

PlatformID that will be assigned to the new account

safeName:

SafeName that will be assigned to the new account

address:

Address that will be assigned to the new account

username:

Username that will be assigned to the new account

Add-VPASAccountGroup : Required Parameters

GroupName:

Unique target GroupName for the account group - An account group is set of accounts that will have the same password synced across the entire group

GroupPlatformID:

Unique ID that maps to the target GroupPlatform - Supply GroupPlatformID to skip any querying for target GroupPlatform

Safe:

Target unique safe name

Add-VPASAccountRequest : Required Parameters

Reason:

Purpose for opening this account request

Add-VPASAccountToAccountGroup : Required Parameters

This command has NO required parameters

Add-VPASAllowedIP : Required Parameters

AllowedValue:

Target value that will be whitelisted to allow cyberark cloud to communicate to - CIDR ranges (/22 netmask or /32 netmask) can be utilized to add a range of IP addresses to the allowlist

Add-VPASAllowedReferrer : Required Parameters

ReferrerURL:

Target URL that will be whitelisted to allow the PVWA to redirect from

Add-VPASApplication : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Add-VPASApplicationAuthentication : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

AuthType:

Define the type of the target authentication - Possible values: Path, Hash, OSUser, machineAddress, certificateSerialNumber

AuthValue:

Value to be added to the target AppID

Add-VPASAuthenticationMethod : Required Parameters

AuthenticationMethodID:

Unique ID that will be used to map to this AuthenticationMethod

Add-VPASBulkAccounts : Required Parameters

CSVFile:

Location of the CSV file containing the target information

Add-VPASBulkSafeMembers : Required Parameters

CSVFile:

Location of the CSV file containing the target information

Add-VPASBulkSafes : Required Parameters

CSVFile:

Location of the CSV file containing the target information

Add-VPASEPVGroup : Required Parameters

GroupName:

Unique target GroupName that will be used to name the EPVGroup

Add-VPASEPVUser : Required Parameters

Username:

Username that will be assigned to the new EPVUser

Add-VPASIdentityRole : Required Parameters

RoleName:

Unique RoleName that will be applied to the new role being created in Identity

Add-VPASIdentitySecurityQuestionAdmin : Required Parameters

SecurityQuestion:

A question or a phrase that will require a response in the event a user does not have the current credentials of their account in Identity

Add-VPASIdentityUserSecurityQuestions : Required Parameters

QuestionText:

Security question that will be added to the users profile

AnswerText:

Security question answer that will be added to the users profile

Add-VPASMemberEPVGroup : Required Parameters

GroupLookupBy:

Specify method to query for target EPVGroup - Possible values: GroupName, GroupID

GroupLookupVal:

Search value to query for target EPVGroup

EPVUserName:

Target EPVUserName that will be added to target EPVGroup

UserSearchIn:

Specify where to find the target EPVUser - Possible values: Vault, Domain

DomainDNS:

Specify the target directory mapping of the target EPVUser if the user is coming from a location of type Domain

Add-VPASSafe : Required Parameters

safe:

Target unique safe name

Add-VPASSafeMember : Required Parameters

member:

Target unique safe member name

safe:

Target unique safe name

Approve-VPASIncomingRequest : Required Parameters

approveReason:

Reason for approving the incoming request, will be saved for audit purposes

Confirm-VPASBulkFile : Required Parameters

BulkOperation:

Which bulk operation the CSVFile should be tested against - Possible values: BulkSafeCreation, BulkAccountCreation, BulkSafeMembers

CSVFile:

Location of the CSV file containing the target information

Copy-VPASGroupPlatform : Required Parameters

DuplicateFromGroupPlatformID:

Specify which GroupPlatformID will be the base of the new platform

NewGroupPlatformID:

New unique GroupPlatformID for the new platform

Copy-VPASPlatform : Required Parameters

DuplicateFromPlatformID:

Specify which PlatformID will be the base of the new platform

NewPlatformID:

New unique PlatformID for the new platform

Copy-VPASRotationalPlatform : Required Parameters

DuplicateFromRotationalPlatformID:

Specify which RotationalPlatformID will be the base of the new platform

NewRotationalPlatformID:

New unique RotationalPlatformID for the new platform

Copy-VPASUsagePlatform : Required Parameters

DuplicateFromUsagePlatformID:

Specify which UsagePlatformID will be the base of the new platform

NewUsagePlatformID:

New unique UsagePlatformID for the new platform

Deny-VPASIncomingRequest : Required Parameters

denyReason:

Reason for denying the incoming request, will be saved for audit purposes

Disable-VPASEPVUser : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

Disable-VPASGroupPlatform : Required Parameters

DeactivateGroupPlatformID:

Unique GroupPlatformID that will be deactivated

Disable-VPASPlatform : Required Parameters

DeactivatePlatformID:

Unique PlatformID that will be deactivated

Disable-VPASRotationalPlatform : Required Parameters

DeactivateRotationalPlatformID:

Unique RotationalPlatformID that will be deactivated

Enable-VPASEPVUser : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

Action:

Select to either Enable target EPVUser or Activate target EPVUser - Enabling a user will allow the user to authenticate in, Activating a user will clear out any authentication failures and unsuspend the user if suspended - Possible values: Enable, Activate

Enable-VPASGroupPlatform : Required Parameters

ActivateGroupPlatformID:

Unique GroupPlatformID that will be activated

Enable-VPASPlatform : Required Parameters

ActivatePlatformID:

Unique PlatformID that will be activated

Enable-VPASRotationalPlatform : Required Parameters

ActivateRotationalPlatformID:

Unique RotationalPlatformID that will be activated

Export-VPASPlatform : Required Parameters

PlatformName:

Unique target PlatformName that will be exported

Get-VPASAccountActivity : Required Parameters

This command has NO required parameters

Get-VPASAccountDetails : Required Parameters

This command has NO required parameters

Get-VPASAccountGroupMembers : Required Parameters

This command has NO required parameters

Get-VPASAccountGroups : Required Parameters

safe:

Target unique safe name

Get-VPASAccountPrivateSSHKey : Required Parameters

reason:

Define a reason for connecting for audit purposes

Get-VPASAccountRequestDetails : Required Parameters

This command has NO required parameters

Get-VPASActiveSessionActivities : Required Parameters

This command has NO required parameters

Get-VPASActiveSessionProperties : Required Parameters

This command has NO required parameters

Get-VPASActiveSessions : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASAllAccountRequests : Required Parameters

This command has NO required parameters

Get-VPASAllAccounts : Required Parameters

This command has NO required parameters

Get-VPASAllActiveSessions : Required Parameters

This command has NO required parameters

Get-VPASAllApplications : Required Parameters

This command has NO required parameters

Get-VPASAllConnectionComponents : Required Parameters

This command has NO required parameters

Get-VPASAllDirectories : Required Parameters

This command has NO required parameters

Get-VPASAllDiscoveredAccounts : Required Parameters

This command has NO required parameters

Get-VPASAllEPVGroups : Required Parameters

This command has NO required parameters

Get-VPASAllEPVUsers : Required Parameters

This command has NO required parameters

Get-VPASAllGroupPlatforms : Required Parameters

This command has NO required parameters

Get-VPASAllIncomingRequests : Required Parameters

This command has NO required parameters

Get-VPASAllowedIPs : Required Parameters

This command has NO required parameters

Get-VPASAllowedReferrer : Required Parameters

This command has NO required parameters

Get-VPASAllPlatforms : Required Parameters

This command has NO required parameters

Get-VPASAllPSMServers : Required Parameters

This command has NO required parameters

Get-VPASAllPSMSessions : Required Parameters

This command has NO required parameters

Get-VPASAllRotationalPlatforms : Required Parameters

This command has NO required parameters

Get-VPASAllSafes : Required Parameters

This command has NO required parameters

Get-VPASAllTargetPlatforms : Required Parameters

This command has NO required parameters

Get-VPASAllUsagePlatforms : Required Parameters

This command has NO required parameters

Get-VPASApplicationAuthentications : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Get-VPASApplicationDetails : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Get-VPASAuthenticationMethods : Required Parameters

This command has NO required parameters

Get-VPASBulkTemplateFiles : Required Parameters

BulkTemplate:

Specific bulk operation to generate a CSVFile for - Possible values: BulkSafeCreation, BulkAccountCreation, BulkSafeMembers

Get-VPASCMAllComponents : Required Parameters

This command has NO required parameters

Get-VPASCMAllConnectorComponents : Required Parameters

This command has NO required parameters

Get-VPASCMAllConnectorPools : Required Parameters

This command has NO required parameters

Get-VPASCMAllConnectors : Required Parameters

This command has NO required parameters

Get-VPASCMComponentLogList : Required Parameters

This command has NO required parameters

Get-VPASCMComponentLogs : Required Parameters

This command has NO required parameters

Get-VPASCMConnectorComponentDetails : Required Parameters

This command has NO required parameters

Get-VPASCMConnectorDetails : Required Parameters

This command has NO required parameters

Get-VPASCMConnectorPoolDetails : Required Parameters

This command has NO required parameters

Get-VPASCMConnectors : Required Parameters

SearchQuery:

Search string to find target resource

Get-VPASCurrentEPVUserDetails : Required Parameters

This command has NO required parameters

Get-VPASDirectoryDetails : Required Parameters

DirectoryID:

Unique DirectoryID that maps to the target Directory to retrieve details

Get-VPASDirectoryMappingDetails : Required Parameters

This command has NO required parameters

Get-VPASDirectoryMappings : Required Parameters

DomainName:

Target domain to query details for

Get-VPASDiscoveredAccounts : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASDiscoveredAccountsDependencies : Required Parameters

This command has NO required parameters

Get-VPASDPAAllPolicies : Required Parameters

This command has NO required parameters

Get-VPASDPAAllStrongAccounts : Required Parameters

This command has NO required parameters

Get-VPASDPAAllStrongAccountSets : Required Parameters

This command has NO required parameters

Get-VPASDPAPolicies : Required Parameters

SearchQuery:

Search string to find target resource

Get-VPASDPAPolicyDetails : Required Parameters

This command has NO required parameters

Get-VPASDPASettings : Required Parameters

This command has NO required parameters

Get-VPASDPAStrongAccountDetails : Required Parameters

This command has NO required parameters

Get-VPASDPAStrongAccounts : Required Parameters

SearchQuery:

Search string to find target resource

Get-VPASEPVGroupDetails : Required Parameters

GroupName:

Target EPV group name

Get-VPASEPVUserDetails : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

Get-VPASEPVUserDetailsSearch : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASEPVUserTypes : Required Parameters

This command has NO required parameters

Get-VPASGroupPlatformDetails : Required Parameters

groupplatformID:

Unique GroupPlatformID to retrieve details for

Get-VPASIdentityAdminSecurityQuestion : Required Parameters

This command has NO required parameters

Get-VPASIdentityAllAdminSecurityQuestions : Required Parameters

This command has NO required parameters

Get-VPASIdentityAllRoles : Required Parameters

This command has NO required parameters

Get-VPASIdentityAllUsers : Required Parameters

This command has NO required parameters

Get-VPASIdentityCurrentUserDetails : Required Parameters

This command has NO required parameters

Get-VPASIdentityCurrentUserSecurityQuestions : Required Parameters

This command has NO required parameters

Get-VPASIdentityRoleDetails : Required Parameters

This command has NO required parameters

Get-VPASIdentityRoles : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASIdentityTenantDetails : Required Parameters

This command has NO required parameters

Get-VPASIdentityUserDetails : Required Parameters

This command has NO required parameters

Get-VPASIdentityUserSecurityQuestions : Required Parameters

This command has NO required parameters

Get-VPASIncomingRequestDetails : Required Parameters

This command has NO required parameters

Get-VPASPasswordHistory : Required Parameters

This command has NO required parameters

Get-VPASPasswordValue : Required Parameters

reason:

Define a reason for connecting for audit purposes

Get-VPASPlatformDetails : Required Parameters

platformID:

Unique PlatformID to retrieve details for

Get-VPASPlatformDetailsSearch : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASPSMSessionActivities : Required Parameters

This command has NO required parameters

Get-VPASPSMSessionDetails : Required Parameters

This command has NO required parameters

Get-VPASPSMSessionProperties : Required Parameters

This command has NO required parameters

Get-VPASPSMSessions : Required Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASPSMSettingsByPlatformID : Required Parameters

PlatformID:

Unique PlatformID to retrieve PSM settings for

Get-VPASRotationalPlatformDetails : Required Parameters

rotationalplatformID:

Unique RotationalPlatformID to retrieve details for

Get-VPASSafeDetails : Required Parameters

safe:

Target unique safe name

Get-VPASSafeMembers : Required Parameters

safe:

Target unique safe name

Get-VPASSafeMemberSearch : Required Parameters

safe:

Target unique safe name

member:

Target unique safe member

Get-VPASSafes : Required Parameters

searchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

Get-VPASSafesByPlatformID : Required Parameters

PlatformID:

Unique PlatformID to retrieve safes for

Get-VPASSpecificAuthenticationMethod : Required Parameters

This command has NO required parameters

Get-VPASSQLAccounts : Required Parameters

This command has NO required parameters

Get-VPASSQLPlatforms : Required Parameters

This command has NO required parameters

Get-VPASSQLSafes : Required Parameters

This command has NO required parameters

Get-VPASSystemComponents : Required Parameters

This command has NO required parameters

Get-VPASSystemHealth : Required Parameters

Component:

Define which component to pull health status for - Possible values: AIM, PSM, CPM, PVWA, PTA

Get-VPASUsagePlatformDetails : Required Parameters

usageplatformID:

Unique UsagePlatformID to retrieve details for

Get-VPASVaultDetails : Required Parameters

This command has NO required parameters

Get-VPASVaultVersion : Required Parameters

This command has NO required parameters

Import-VPASConnectionComponent : Required Parameters

ZipPath:

The location of the zip file containing connection component details files

Import-VPASPlatform : Required Parameters

ZipPath:

The location of the zip file containing platform details files

Invoke-VPASAccountPasswordAction : Required Parameters

action:

Specify what action will be run on the account - Possible values: Verify, Reconcile, Change, ChangeOnlyInVault, ChangeSetNew, GeneratePassword

Invoke-VPASActivePSMSessionAction : Required Parameters

Action:

Specify what action should be taken - Possible values: Suspend, Resume, Terminate

Invoke-VPASAuditSafeTest : Required Parameters

This command has NO required parameters

Invoke-VPASCentralCredentialProvider : Required Parameters

ApplicationID:

The application ID that has access to the safe that will retrieve the account information

Safe:

Safe that the target account is located in

ObjectName:

Unique identifier of the target account

CCPServer:

Server fully qualified domain name (FQDN) or IP that the central credential provider(s) are deployed on

Invoke-VPASCredentialProvider : Required Parameters

ApplicationID:

The application ID that has access to the safe that will retrieve the account information

Safe:

Safe that the target account is located in

ObjectName:

Unique identifier of the target account

SDKLocation:

Location or filepath to the CLIPasswordSDK that will be utilized to make the call - Default value: 'C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK.exe'

Invoke-VPASMetricsAccounts : Required Parameters

TargetMetric:

Specify which report will be run - Possible values: OnboardedAccountTypes, AccountsOnboardedXDays, AccountComplianceStatus

MetricFormat:

Specify the report output format - NONE will return the generated hashtable of data that can be assigned to a variable - Possible values: JSON, HTML, ALL, NONE

Invoke-VPASMetricsCPM : Required Parameters

TargetMetric:

Specify which report will be run - Possible values: CPMAssignedToSafes, CPMAssignedToAccounts, CPMAccountManagementStatus

MetricFormat:

Specify the report output format - NONE will return the generated hashtable of data that can be assigned to a variable - Possible values: JSON, HTML, ALL, NONE

Invoke-VPASMetricsPlatforms : Required Parameters

TargetMetric:

Specify which report will be run - Possible values: AccountsAssignedToPlatforms, AutomaticVsManualRotation, AutomaticVsManualVerification

MetricFormat:

Specify the report output format - NONE will return the generated hashtable of data that can be assigned to a variable - Possible values: JSON, HTML, ALL, NONE

Invoke-VPASMetricsProviders : Required Parameters

TargetMetric:

Specify which report will be run - Possible values: ApplicationIDsOnSafes, AccountsPulledViaApplicationID

MetricFormat:

Specify the report output format - NONE will return the generated hashtable of data that can be assigned to a variable - Possible values: JSON, HTML, ALL, NONE

Invoke-VPASMetricsPSM : Required Parameters

TargetMetric:

Specify which report will be run - Possible values: PSMSessionsInXDays, PSMUtilizationForXDays, PSMConnectionComponentsInXDays, UsersConnectingWithPSMInXDays

MetricFormat:

Specify the report output format - NONE will return the generated hashtable of data that can be assigned to a variable - Possible values: JSON, HTML, ALL, NONE

DayRange:

Specify the date range for the selected metric report

Invoke-VPASQuery : Required Parameters

query:

SQL statement to be run against the database hosting outputs from VpasModule

Invoke-VPASReporting : Required Parameters

ReportType:

Specify which report will be run - Possible values: SafeContent, SafeMembers, PlatformDetails, EPVUsers, PlatformLinkedAccounts, ApplicationIDAuthentications

ReportFormat:

Specify what format the report output should be - Possible values: CSV, JSON, TXT, HTML, XML, ALL

Invoke-VPASUserLicenseReport : Required Parameters

This command has NO required parameters

New-VPASDPASetupScript : Required Parameters

ConnectorType:

Platform type the connector will be deployed to - Possible values: AWS, AZURE, ON-PREMISE, GCP

ConnectorOS:

Operating system type the connector will be deployed to - Possible values: windows, darwin, linux

ConnectorPoolID:

UniqueID of the pool the connector will be deployed to - ID is typically a long string value like so: a1bcd234-efg5-67h8-90ij-9876k54lm321

New-VPASIdentityGenerateUserPassword : Required Parameters

passwordLength:

Specify how many characters the generated password should be

New-VPASPSMSession : Required Parameters

ConnectionComponent:

Define which connection component will be used via ConnectionComponentID - ConnectionComponentID is the ID given to the Connection Component (for example PSM-RDP for RDP, and PSM-SSH for SSH)

Remove-VPASAccount : Required Parameters

This command has NO required parameters

Remove-VPASAccountFromAccountGroup : Required Parameters

This command has NO required parameters

Remove-VPASAccountRequest : Required Parameters

This command has NO required parameters

Remove-VPASAllDiscoveredAccounts : Required Parameters

This command has NO required parameters

Remove-VPASApplication : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Remove-VPASApplicationAuthentication : Required Parameters

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Remove-VPASAuthenticationMethod : Required Parameters

This command has NO required parameters

Remove-VPASDirectory : Required Parameters

DirectoryID:

Unique DirectoryID that maps to the target Directory to be deleted

Remove-VPASDPAPolicy : Required Parameters

This command has NO required parameters

Remove-VPASDPAStrongAccount : Required Parameters

This command has NO required parameters

Remove-VPASEPVGroup : Required Parameters

GroupLookupBy:

Define the method by which the EPV groups will be queried by - Possible values: GroupName, GroupID

GroupLookupVal:

Search value that will be used to query for target EPV group

Remove-VPASEPVUser : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

Remove-VPASGroupPlatform : Required Parameters

DeleteGroupPlatformID:

Unique GroupPlatformID to delete

Remove-VPASIdentityAdminSecurityQuestion : Required Parameters

This command has NO required parameters

Remove-VPASIdentityRole : Required Parameters

This command has NO required parameters

Remove-VPASLinkedAccount : Required Parameters

AccountType:

Define which type of account will be removed - Possible values: LogonAcct, JumpAcct, ReconAcct

Remove-VPASMemberEPVGroup : Required Parameters

GroupLookupBy:

Specify method to query for target EPVGroup - Possible values: GroupName, GroupID

GroupLookupVal:

Search value to query for target EPVGroup

EPVUserName:

Target EPVUserName that will be removed from target EPVGroup

Remove-VPASPlatform : Required Parameters

DeletePlatformID:

Unique PlatformID to delete

Remove-VPASRotationalPlatform : Required Parameters

DeleteRotationalPlatformID:

Unique RotationalPlatformID to delete

Remove-VPASSafe : Required Parameters

safe:

Target unique safe name

Remove-VPASSafeMember : Required Parameters

safe:

Target unique safe name

member:

Target unique safe member

Remove-VPASToken : Required Parameters

This command has NO required parameters

Remove-VPASUsagePlatform : Required Parameters

UsagePlatformID:

Unique UsagePlatformID to delete

Reset-VPASEPVUserPassword : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

NewPassword:

New temporary password that will be applied to the target EPVUser

Reset-VPASIdentityUserSecurityQuestions : Required Parameters

This command has NO required parameters

Set-VPASAuditSafeTest : Required Parameters

This command has NO required parameters

Set-VPASIdentityUserState : Required Parameters

State:

Specify the state status of the target user in Identity - Possible values: None, Locked, Disabled, Expired

Set-VPASIdentityUserStatus : Required Parameters

LockUser:

Specify the locked status of the target user in Identity - Possible values: TRUE, FALSE

Set-VPASLinkedAccount : Required Parameters

AccountType:

Type of account that is being linked - Possible values: LogonAcct, JumpAcct, ReconAcct

extraAcctSafe:

Safe value of the extra account being linked

extraAcctFolder:

Folder value of the extra account being linked

extraAcctName:

ObjectName value of the extra account being linked

Set-VPASSQLConnectionDetails : Required Parameters

This command has NO required parameters

Test-VPASIdentityUserLocked : Required Parameters

This command has NO required parameters

Test-VPASSQLConnectionDetails : Required Parameters

This command has NO required parameters

Unlock-VPASExclusiveAccount : Required Parameters

This command has NO required parameters

Update-VPASAccountFields : Required Parameters

action:

Which action will be taken on the updated fields - Possible values: Add, Remove, Replace

field:

Define which field will be updated - Possible values: Name, Address, PlatformID, Username, Status, StatusReason, RemoteMachines, AccessRestrictedToRemoteMachines, LogonDomain

fieldval:

Target value that will be used to update the target field

Update-VPASAuthenticationMethod : Required Parameters

This command has NO required parameters

Update-VPASEPVGroup : Required Parameters

GroupLookupBy:

Define the method by which the EPV groups will be queried by - Possible values: GroupName, GroupID

GroupLookupVal:

Search value that will be used to query for target EPV group

NewGroupName:

New group name that the target EPV group will be updated with

Update-VPASEPVUser : Required Parameters

LookupBy:

Which method will be used to query for the target EPVUser, via Username or UserID - Possible values: Username, UserID

LookupVal:

Target searchquery string

Update-VPASIdentityCurrentUserPassword : Required Parameters

oldPassword:

Current password of the current user in Identity

newPassword:

New password that will be set for the current user in Identity

Update-VPASIdentityRole : Required Parameters

Action:

Specify the action taken on the target Role - Possible values: AddUser, RemoveUser, AddRole, RemoveRole, EditDescription

ActionValue:

Value that will be updated on the target Role based on selected action

Update-VPASPSMSettingsByPlatformID : Required Parameters

PlatformID:

Unique PlatformID that will be updated

Update-VPASSafe : Required Parameters

safe:

Target unique safe name

field:

Specify which field will be updated - Possible values: SafeName, Description, OLACEnabled, ManagingCPM, NumberOfVersionsRetention, NumberOfDaysRetention

fieldval:

Target value to update the target field with

Update-VPASSafeMember : Required Parameters

member:

Target unique safe member name

safe:

Target unique safe name

Watch-VPASActivePSMSession : Required Parameters

This command has NO required parameters

Add-VPASAccount : Optional Parameters

accessRestrictedToRemoteMachines:

Limit if the new account can only connect to specific remote machines - Possible values: TRUE, FALSE

remoteMachines:

Specific remote machines that the new account can connect to

automaticManagementEnabled:

Enable for the account to be automatically managed by the CPM depending on platform settings and configurations - Possible values: TRUE, FALSE

manualManagementReason:

Specify a reason for automatic management to be disabled

extraProps:

Include extra properties that can be defined based on platform settings and configurations - Pass extra properties in a hashtable following this pattern: @{ OptionalProperty1Tag = "OptionalProperty1Value" } - Oracle Example: -extraProps @{ Database = "VmanDB" }

secretType:

Type of secret that will be assigned to the new account - Possible values: Password, Key

name:

ObjectName that will be assigned to the new account

secret:

Secret that will be assigned to the new account

Add-VPASAccountGroup : Optional Parameters

This command has NO optional parameters

Add-VPASAccountRequest : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

MultipleAccess:

MultipleAccess type request gives the ability to use the account multiple times within a requested time frame

FromDateTime:

Start of the date range for the account request - Value should follow this format: MM/dd/yyyy HH:mm:ss

ToDateTime:

End of the date range for the account request - Value should follow this format: MM/dd/yyyy HH:mm:ss

UseConnect:

Gives this account request the ability to connect via PSM if approved

ConnectionComponent:

Specify the connection component that will be used if UseConnect is enabled - Example value: PSM-RDP, PSM-SSH, PSM-vSphere

Hostname:

Specify the hostname that will be connected to if the account request is for a domain account - This value will populate the PSMRemoteMachine parameter

Add-VPASAccountToAccountGroup : Optional Parameters

GroupID:

Unique ID that maps to the target AccountGroup - Supply GroupID to skip any querying for target AccountGroup

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

GroupName:

Unique target GroupName that will be used to query for the GroupID if no GroupID is passed - An account group is set of accounts that will have the same password synced across the entire group

Add-VPASAllowedIP : Optional Parameters

This command has NO optional parameters

Add-VPASAllowedReferrer : Optional Parameters

RegularExpression:

Define if the ReferrerURL will be treated as a regular expression

Add-VPASApplication : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Location:

Where the ApplicationID will reside in terms of the directory structure within CyberArk

AccessPermittedFrom:

Limiting when an ApplicationID can be used starting time

AccessPermittedTo:

Limiting when an ApplicationID can be used end time

ExpirationDate:

Limiting when an ApplicationID can be used expiration date

Disabled:

Create the new ApplicationID in a disabled state

BusinessOwnerFName:

ApplicationID owner FirstName

BusinessOwnerLName:

ApplicationID owner LastName

BusinessOwnerEmail:

ApplicationID onwer Email

BusinessOwnerPhone:

ApplicationID owner Phone

Add-VPASApplicationAuthentication : Optional Parameters

IsFolder:

Define if the AuthValue is a folder if using an authentication type: path

AllowInternalScripts:

Define if internal scripts have permission to pull credentials if using an authentication type: path

Add-VPASAuthenticationMethod : Optional Parameters

DisplayName:

Display value of the AuthenticationMethod

Enabled:

Specify if the AuthenticationMethod will be enabled - AuthenticationMethod will NOT appear if set to disabled - Possible values: TRUE, FALSE

MobileEnabled:

Allow the AuthenticationMethod to be visible on mobile - Possible values: TRUE, FALSE

LogoffURL:

Redirect link that EndUsers will funnel through on logoff

SecondFactorAuth:

Enable a second factor authentication - Possible values: cyberark, radius, ldap

SignInLabel:

Visual title of the AuthenticationMethod - This is what EndUsers will see

UsernameFieldLabel:

Visual tag for the Username box - This is what EndUsers will see

PasswordFieldLabel:

Visual tag for the Password box - This is what EndUsers will see

Add-VPASBulkAccounts : Optional Parameters

This command has NO optional parameters

Add-VPASBulkSafeMembers : Optional Parameters

SkipConfirmation:

Skip prompting for confirmation to proceed if the target safe member already exists in the target safe - The provided permissions in the CSVFile will overwrite/replace the existing permissions

Add-VPASBulkSafes : Optional Parameters

This command has NO optional parameters

Add-VPASEPVGroup : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Location:

Define where the new EPV group will be located within the CyberArk directory

Add-VPASEPVUser : Optional Parameters

UserType:

The user type of the EPVUser being created - UserTypes are determined by the current license in the environment, as well as how many seats are available per UserType - Possible values: EPVUser, AIMAccount, CPM, PVWA, PSMHTML5Gateway, PSM, AppProvider, OPMProvider, CCPEndpoints, PSMUser, IBVUser, AutoIBVUser, CIFS, FTP, SFE, DCAUser, DCAInstance, SecureEpClientUser, ClientlessUser, AdHocRecipient, SecureEmailUser, SEG, PSMPADBridge, PSMPServer, AllUsers, DR_USER, BizUser, PTA, DiscoveryApp, xRayAdminApp, PSMWeb, EPMUser, DAPService

Location:

Where the EPVUser will reside in terms of the directory structure within CyberArk

InitialPassword:

Temporary initial password of the EPVUser

PasswordNeverExpires:

If the password will ever expire or follow a scheduled expiry schedule

ChangePasswordOnTheNextLogon:

Change the password of the new EPVUser upon first time login

DisableUser:

Disable the the new EPVUser account - Disabled accounts are NOT able to log into CyberArk

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Street:

EPVUser Street value

City:

EPVUser City value

State:

EPVUser State value

Zip:

EPVUser Zip value

Country:

EPVUser Country value

Title:

EPVUser Title value

Organization:

EPVUser Organization value

Department:

EPVUser Department value

Profession:

EPVUser Profession value

FirstName:

EPVUser FirstName value

MiddleName:

EPVUser MiddleName value

LastName:

EPVUser LastName value

HomeNumber:

EPVUser HomeNumber value

BusinessNumber:

EPVUser BusinessNumber value

CellularNumber:

EPVUser CellularNumber value

FaxNumber:

EPVUser FaxNumber value

PagerNumber:

EPVUser PagerNumber value

HomePage:

EPVUser HomePage value

HomeEmail:

EPVUser HomeEmail value

BusinessEmail:

EPVUser BusinessEmail value

OtherEmail:

EPVUser OtherEmail value

WorkStreet:

EPVUser WorkStreet value

WorkCity:

EPVUser WorkCity value

WorkState:

EPVUser WorkState value

WorkZip:

EPVUser WorkZip value

WorkCountry:

EPVUser WorkCountry value

AddSafes:

VaultAuthorization permission that gives rights for an EPVUser to create safes

AuditUsers:

VaultAuthorization permission that gives rights for an EPVUser to view other EPVUser details

AddUpdateUsers:

VaultAuthorization permission that gives rights for an EPVUser to add new EPVUsers or update existing EPVUsers

ResetUsersPasswords:

VaultAuthorization permission that gives rights for an EPVUser to reset credentials for other EPVUsers

ActivateUsers:

VaultAuthorization permission that gives rights for an EPVUser to Activate other EPVUsers (if the EPVUser becomes inactive)

AddNetworkAreas:

VaultAuthorization permission that gives rights for an EPVUser to create Networking Areas - Networking Areas limit where an account can be used from

ManageDirectoryMapping:

VaultAuthorization permission that gives rights for an EPVUser to create/edit/delete directory mappings created during LDAP integration

ManageServerFileCategories:

VaultAuthorization permission that gives rights for an EPVUser to create/modify/delete ServerFileCategories

BackupAllSafes:

VaultAuthorization permission that gives rights for an EPVUser to be able to backup an existing safe

RestoreAllSafes:

VaultAuthorization permission that gives rights for an EPVUser to be able to restore safes

AuthenticationType:

Authentication method that the EPVUser will login with

DistinguishedName:

Users distinguished name, used for PKI authentication - This should match the Certificate SubjectName or Domain Name

Add-VPASIdentityRole : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Add-VPASIdentitySecurityQuestionAdmin : Optional Parameters

This command has NO optional parameters

Add-VPASIdentityUserSecurityQuestions : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Add-VPASMemberEPVGroup : Optional Parameters

This command has NO optional parameters

Add-VPASSafe : Optional Parameters

passwordManager:

Define which CPM will be assigned to the safe - A blank value or not passing a CPM will NOT assign a CPM to the safe

numberOfVersionsRetention:

Define how many versions of passwords will be kept in an accounts history

numberOfDaysRetention:

Define how many days worth of passwords will be kept in an accounts history

OLACEnabled:

Define if to turn on OLAC (Object Level Access Control) for the safe

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Add-VPASSafeMember : Optional Parameters

searchin:

Which directory to search in for the target safe member. This value is defined during LDAP integration. - If searching for a user internally use the value "vault"

AllPerms:

Enables all safe permissions

AllAccess:

Enables all Access safe permissions (UseAccounts, RetrieveAccounts, ListAccounts)

AllAccountManagement:

Enables all AccountManagement safe permissions (AddAccounts, UpdateAccountContent, UpdateAccountProperties, InitiateCPMAccountManagementOperations, SpecifyNextAccountContent, RenameAccounts, DeleteAccounts, UnlockAccounts)

AllMonitor:

Enables all Monitor safe permissions (ViewAuditLog, ViewSafeMembers)

AllSafeManagement:

Enables all SafeManagement safe permissions (ManageSafe, ManageSafeMembers, BackupSafe)

AllWorkflow:

Enables all Workflow safe permissions (RequestsAuthorizationLevel1, AccessWithoutConfirmation)

AllAdvanced:

Enables all Advanced safe permissions (CreateFolders, DeleteFolders, MoveAccountsAndFolders)

UseAccounts:

Gives the ability use accounts in a safe (click the connect button)

RetrieveAccounts:

Gives the ability to pull accounts credentials in a safe (click the Show/Copy buttons)

ListAccounts:

Gives the ability to view accounts in a safe

AddAccounts:

Gives the ability to add accounts in a safe

UpdateAccountContent:

Gives the ability to manually update accounts secrets in a safe

UpdateAccountProperties:

Gives the ability to update account properties in a safe (username field, address field, etc)

InitiateCPMAccountManagementOperations:

Gives the ability to trigger the CPM to run a change, verify, or reconcile on accounts in a safe

SpecifyNextAccountContent:

Gives the ability to specify what the next password the CPM will push to accounts in a safe

RenameAccounts:

Gives the ability to modify the ObjectName of accounts in a safe

DeleteAccounts:

Gives the ability to delete accounts from a safe

UnlockAccounts:

Gives the ability to unlock or check-in locked account on someone else's behalf in a safe

ManageSafe:

Gives the ability to modify safe details (DaysRetention, VersionRetention, Description, etc)

ManageSafeMembers:

Gives the ability to add, remove, modify safe members on a safe

BackupSafe:

Gives the ability to backup a safe

ViewAuditLog:

Gives the ability to view the activities performed on accounts in a safe

ViewSafeMembers:

Gives the ability to view safe members on a safe

AccessWithoutConfirmation:

Gives the ability to access the safe without needing confirmation from an approver

CreateFolders:

Gives the ability to create folders in a safe

DeleteFolders:

Gives the ability to delete folders from a safe

MoveAccountsAndFolders:

Gives the ability to move accounts and folders from one safe to another

RequestsAuthorizationLevel1:

Gives the ability to approve or deny users from using an account (Level1) in a safe

RequestsAuthorizationLevel2:

Gives the ability to approve or deny users from using an account (Level2) in a safe

MemberType:

Specify whether the target safe member is of type User, Group, or Role. - This will save time querying for the targe safe member. - Possible values: "User", "Group", "Role"

SafePermissionHashTable:

Hashtable that contains the set of safe permissions to be applied to a specific safe member. - Hashtable has priority over the safe permission flags that are passed

Approve-VPASIncomingRequest : Optional Parameters

RequestedSafe:

Safe name that will be used to query for the target account if no AcctID is passed

RequestedPlatform:

PlatformID that will be used to query for the target account if no AcctID is passed

RequestedUsername:

Username that will be used to query for the target account if no AcctID is passed

RequestedAddress:

Address that will be used to query for the target account if no AcctID is passed

RequestedAcctID:

Unique ID that maps to a single account, passing this variable will skip query functions to find target account

RequestedReason:

Reason that will be used to query and find the target account request

requestID:

Unique ID that maps to a single account request, passing this variable will skip any query functions

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Confirm-VPASBulkFile : Optional Parameters

ISPSS:

For saas environments - The APIs for adding safe members introduced a new parameter for saas environments. Enable this flag for saas environments

HideOutput:

Suppress any output to the console

Copy-VPASGroupPlatform : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Copy-VPASPlatform : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Copy-VPASRotationalPlatform : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Copy-VPASUsagePlatform : Optional Parameters

Description:

An explanation/details of the target resource - Best practice states to leave informative descriptions to help identify the resource purpose

Deny-VPASIncomingRequest : Optional Parameters

RequestedSafe:

Safe name that will be used to query for the target account if no AcctID is passed

RequestedPlatform:

PlatformID that will be used to query for the target account if no AcctID is passed

RequestedUsername:

Username that will be used to query for the target account if no AcctID is passed

RequestedAddress:

Address that will be used to query for the target account if no AcctID is passed

RequestedAcctID:

Unique ID that maps to a single account, passing this variable will skip query functions to find target account

RequestedReason:

Reason that will be used to query and find the target account request

requestID:

Unique ID that maps to a single account request, passing this variable will skip any query functions

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Disable-VPASEPVUser : Optional Parameters

This command has NO optional parameters

Disable-VPASGroupPlatform : Optional Parameters

This command has NO optional parameters

Disable-VPASPlatform : Optional Parameters

This command has NO optional parameters

Disable-VPASRotationalPlatform : Optional Parameters

This command has NO optional parameters

Enable-VPASEPVUser : Optional Parameters

This command has NO optional parameters

Enable-VPASGroupPlatform : Optional Parameters

This command has NO optional parameters

Enable-VPASPlatform : Optional Parameters

This command has NO optional parameters

Enable-VPASRotationalPlatform : Optional Parameters

This command has NO optional parameters

Export-VPASPlatform : Optional Parameters

Directory:

Location where the exported files should be placed

HideOutput:

Suppress any output to the console

Get-VPASAccountActivity : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Get-VPASAccountDetails : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

ExactMatch:

Returns accounts that match search query exactly (not a wildcard search)

HideWarning:

Hide any warning outputs from the console during the API session

SavedFilter:

Returns accounts based on a prebuilt search query - Possible values: "Regular", "Recently", "New", "Link", "Deleted", "PolicyFailures", "AccessedByUsers", "ModifiedByUsers", "ModifiedByCPM", "DisabledPasswordByUser", "DisabledPasswordByCPM", "ScheduledForChange", "ScheduledForVerify", "ScheduledForReconcile", "SuccessfullyReconciled", "FailedChange", "FailedVerify", "FailedReconcile", "LockedOrNew", "Locked", "Favorites"

Get-VPASAccountGroupMembers : Optional Parameters

GroupID:

Unique ID that maps to the target AccountGroup - Supply GroupID to skip any querying for target AccountGroup

safe:

Target unique safe name

GroupName:

Unique target GroupName that will be used to query for the GroupID if no GroupID is passed - An account group is set of accounts that will have the same password synced across the entire group

Get-VPASAccountGroups : Optional Parameters

This command has NO optional parameters

Get-VPASAccountPrivateSSHKey : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

SaveToFile:

The key will be saved to a PEM file

HideOutput:

Suppress any output to the console

Get-VPASAccountRequestDetails : Optional Parameters

RequestedSafe:

Safe name that will be used to query for the target account if no AcctID is passed

RequestedPlatform:

PlatformID that will be used to query for the target account if no AcctID is passed

RequestedUsername:

Username that will be used to query for the target account if no AcctID is passed

RequestedAddress:

Address that will be used to query for the target account if no AcctID is passed

RequestedAcctID:

Unique ID that maps to a single account, passing this variable will skip query functions to find target account

RequestedReason:

Reason that will be used to query and find the target account request

requestID:

Unique ID that maps to a single account request, passing this variable will skip any query functions

Get-VPASActiveSessionActivities : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

ActiveSessionID:

Unique ID that maps to the target ActiveSession - Supply the ActiveSessionID to skip any querying to find the target ActiveSession

Get-VPASActiveSessionProperties : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

ActiveSessionID:

Unique ID that maps to the target ActiveSession - Supply the ActiveSessionID to skip any querying to find the target ActiveSession

Get-VPASActiveSessions : Optional Parameters

This command has NO optional parameters

Get-VPASAllAccountRequests : Optional Parameters

IncludeExpiredRequests:

Switch if to include account requests that have already expired

OnlyPendingRequests:

Switch if to only return account requests that are still pending an approval

Get-VPASAllAccounts : Optional Parameters

This command has NO optional parameters

Get-VPASAllActiveSessions : Optional Parameters

This command has NO optional parameters

Get-VPASAllApplications : Optional Parameters

This command has NO optional parameters

Get-VPASAllConnectionComponents : Optional Parameters

This command has NO optional parameters

Get-VPASAllDirectories : Optional Parameters

This command has NO optional parameters

Get-VPASAllDiscoveredAccounts : Optional Parameters

This command has NO optional parameters

Get-VPASAllEPVGroups : Optional Parameters

IncludeMembers:

Switch to include group members in the return value per EPVGroup or not

Get-VPASAllEPVUsers : Optional Parameters

This command has NO optional parameters

Get-VPASAllGroupPlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASAllIncomingRequests : Optional Parameters

IncludeExpiredRequests:

Switch if to include incoming requests that have already expired

OnlyPendingRequests:

Switch if to only return incoming requests that are still pending an approval

Get-VPASAllowedIPs : Optional Parameters

This command has NO optional parameters

Get-VPASAllowedReferrer : Optional Parameters

This command has NO optional parameters

Get-VPASAllPlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASAllPSMServers : Optional Parameters

This command has NO optional parameters

Get-VPASAllPSMSessions : Optional Parameters

This command has NO optional parameters

Get-VPASAllRotationalPlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASAllSafes : Optional Parameters

IncludeAccounts:

Switch if to include accounts in the return value or not

Get-VPASAllTargetPlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASAllUsagePlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASApplicationAuthentications : Optional Parameters

This command has NO optional parameters

Get-VPASApplicationDetails : Optional Parameters

This command has NO optional parameters

Get-VPASAuthenticationMethods : Optional Parameters

This command has NO optional parameters

Get-VPASBulkTemplateFiles : Optional Parameters

OutputDirectory:

Where to place the newly generated CSV template file

ISPSS:

For saas environments - The APIs for adding safe members introduced a new parameter for saas environments. Enable this flag for saas environments

Get-VPASCMAllComponents : Optional Parameters

This command has NO optional parameters

Get-VPASCMAllConnectorComponents : Optional Parameters

ConnectorID:

UniqueID of the target connector in ConnectorManagement

ConnectorHost:

Unique host of the target connector in ConnectorManagement - Host in this case can either be a hostname, a publicIP, or a PrivateIP

Get-VPASCMAllConnectorPools : Optional Parameters

This command has NO optional parameters

Get-VPASCMAllConnectors : Optional Parameters

This command has NO optional parameters

Get-VPASCMComponentLogList : Optional Parameters

ConnectorID:

UniqueID of the target connector in ConnectorManagement

ConnectorHost:

Unique host of the target connector in ConnectorManagement - Host in this case can either be a hostname, a publicIP, or a PrivateIP

ComponentID:

UniqueID of the target component for a connector in ConnectorManagement

ComponentName:

Unique name of the target component for a connector in ConnectorManagement - Possible values: psm, cpm, cpm scanner, Management Agent

Get-VPASCMComponentLogs : Optional Parameters

ConnectorID:

UniqueID of the target connector in ConnectorManagement

ConnectorHost:

Unique host of the target connector in ConnectorManagement - Host in this case can either be a hostname, a publicIP, or a PrivateIP

ComponentID:

UniqueID of the target component for a connector in ConnectorManagement

ComponentName:

Unique name of the target component for a connector in ConnectorManagement - Possible values: psm, cpm, cpm scanner, Management Agent

OutputDirectory:

Where to place the generated logs

Get-VPASCMConnectorComponentDetails : Optional Parameters

ConnectorID:

UniqueID of the target connector in ConnectorManagement

ConnectorHost:

Unique host of the target connector in ConnectorManagement - Host in this case can either be a hostname, a publicIP, or a PrivateIP

ComponentID:

UniqueID of the target component for a connector in ConnectorManagement

ComponentName:

Unique name of the target component for a connector in ConnectorManagement - Possible values: psm, cpm, cpm scanner, Management Agent

Get-VPASCMConnectorDetails : Optional Parameters

ConnectorID:

UniqueID of the target connector in ConnectorManagement

ConnectorHost:

Unique host of the target connector in ConnectorManagement - Host in this case can either be a hostname, a publicIP, or a PrivateIP

Get-VPASCMConnectorPoolDetails : Optional Parameters

PoolID:

UniqueID of the target connector pool in ConnectorManagement

PoolName:

Unique name of the target connector pool in ConnectorManagement

Get-VPASCMConnectors : Optional Parameters

This command has NO optional parameters

Get-VPASCurrentEPVUserDetails : Optional Parameters

This command has NO optional parameters

Get-VPASDirectoryDetails : Optional Parameters

This command has NO optional parameters

Get-VPASDirectoryMappingDetails : Optional Parameters

DomainName:

Target domain to query through

DirectoryMappingName:

Search query to locate target DomainMapping

DirectoryMappingID:

Unique ID that maps to the target Domain Mapping - Supply DirectoryMappingID to skip any querying to find target DirectoryMapping

Get-VPASDirectoryMappings : Optional Parameters

This command has NO optional parameters

Get-VPASDiscoveredAccounts : Optional Parameters

PlatformType:

Limit the scope of accounts returned based on PlatformType - Possible values: Windows Server Local, Windows Desktop Local, Windows Domain, Unix, Unix SSH Key, AWS, AWS Access Keys, Azure Password Management

Privileged:

Limit the scope of accounts returned based on Privileged status - Possible values: true, false

Enabled:

Limit the scope of accounts returned based in account status - Possible values: true, false

Get-VPASDiscoveredAccountsDependencies : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

PlatformType:

Privileged:

Limit the scope of accounts returned based on Privileged status - Possible values: true, false

Enabled:

Limit the scope of accounts returned based in account status - Possible values: true, false

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Confirm:

Skip the confirmation prompt confirming to run against all discovered accounts

Get-VPASDPAAllPolicies : Optional Parameters

This command has NO optional parameters

Get-VPASDPAAllStrongAccounts : Optional Parameters

This command has NO optional parameters

Get-VPASDPAAllStrongAccountSets : Optional Parameters

This command has NO optional parameters

Get-VPASDPAPolicies : Optional Parameters

This command has NO optional parameters

Get-VPASDPAPolicyDetails : Optional Parameters

PolicyID:

UniqueID of the target policy in DPA

PolicyName:

Unique name of the target policy in DPA

Get-VPASDPASettings : Optional Parameters

This command has NO optional parameters

Get-VPASDPAStrongAccountDetails : Optional Parameters

StrongAccountID:

UniqueID of the target strong account in DPA

StrongAccountName:

Unique name of the target strong account in DPA

Get-VPASDPAStrongAccounts : Optional Parameters

This command has NO optional parameters

Get-VPASEPVGroupDetails : Optional Parameters

This command has NO optional parameters

Get-VPASEPVUserDetails : Optional Parameters

This command has NO optional parameters

Get-VPASEPVUserDetailsSearch : Optional Parameters

This command has NO optional parameters

Get-VPASEPVUserTypes : Optional Parameters

This command has NO optional parameters

Get-VPASGroupPlatformDetails : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityAdminSecurityQuestion : Optional Parameters

QuestionSearchQuery:

Search query to locate the target admin security question

QuestionID:

Unique target QuestionID mapping to the target admin security question - Supply the QuestionID to skip any querying for target admin security question

Get-VPASIdentityAllAdminSecurityQuestions : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityAllRoles : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityAllUsers : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityCurrentUserDetails : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityCurrentUserSecurityQuestions : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityRoleDetails : Optional Parameters

RoleName:

Unique RoleName in Identity to query for target RoleID

RoleID:

Target RoleID that maps the target Role in Identity - Supply the RoleID to skip querying for the target Role

Get-VPASIdentityRoles : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityTenantDetails : Optional Parameters

This command has NO optional parameters

Get-VPASIdentityUserDetails : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Get-VPASIdentityUserSecurityQuestions : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

IncludeAdminQuestions:

Include admin set security questions in the results

Get-VPASIncomingRequestDetails : Optional Parameters

RequestedSafe:

Safe name that will be used to query for the target account if no AcctID is passed

RequestedPlatform:

PlatformID that will be used to query for the target account if no AcctID is passed

RequestedUsername:

Username that will be used to query for the target account if no AcctID is passed

RequestedAddress:

Address that will be used to query for the target account if no AcctID is passed

RequestedAcctID:

Unique ID that maps to a single account, passing this variable will skip query functions to find target account

RequestedReason:

Reason that will be used to query and find the target account request

requestID:

Unique ID that maps to a single incoming request, passing this variable will skip any query functions

Get-VPASPasswordHistory : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

ShowTemporary:

Specify if temporary passwords should be included in the history that is being pulled - Temporary passwords are passwords that the CPM attempted to set on the account but failed to do so

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Get-VPASPasswordValue : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

CopyToClipboard:

The password will be copied to the clipboard

HideOutput:

Suppress any output to the console

Get-VPASPlatformDetails : Optional Parameters

This command has NO optional parameters

Get-VPASPlatformDetailsSearch : Optional Parameters

This command has NO optional parameters

Get-VPASPSMSessionActivities : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

PSMSessionID:

Unique ID that maps to the target PSMSession - Supply the PSMSessionID to skip any querying to find the target PSMSession

Get-VPASPSMSessionDetails : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

PSMSessionID:

Unique ID that maps to the target PSMSession - Supply the PSMSessionID to skip any querying to find the target PSMSession

Get-VPASPSMSessionProperties : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

PSMSessionID:

Unique ID that maps to the target PSMSession - Supply the PSMSessionID to skip any querying to find the target PSMSession

Get-VPASPSMSessions : Optional Parameters

FromTime:

Optional parameter to find target recordings based by Date Range - Start date must be in epoch format

ToTime:

Optional parameter to find target recordings based by Date Range - End date must be in epoch format

Get-VPASPSMSettingsByPlatformID : Optional Parameters

This command has NO optional parameters

Get-VPASRotationalPlatformDetails : Optional Parameters

This command has NO optional parameters

Get-VPASSafeDetails : Optional Parameters

IncludeAccounts:

Switch if to include accounts in the return value or not

Get-VPASSafeMembers : Optional Parameters

IncludePredefinedMembers:

Specify to include predefined safe members in the output - Predefined safe members are the members that get added by default to every safe (Master, Batch, Backup, etc)

LimitSearchTo:

Specify if the query should include only Users or Groups - Both Users and Groups are returned by default - Possible values: "UsersOnly", "GroupsOnly"

Get-VPASSafeMemberSearch : Optional Parameters

This command has NO optional parameters

Get-VPASSafes : Optional Parameters

limit:

Upper estimate of the amount of safes in the environment - Round to the nearest 1,000th to confirm all safes are retrieved

offset:

Skip the amount of safes that get retrieved - -offset 25 will skip the first 25 safes that are returned

IncludeAccounts:

Switch if to include accounts in the return value or not

Get-VPASSafesByPlatformID : Optional Parameters

This command has NO optional parameters

Get-VPASSpecificAuthenticationMethod : Optional Parameters

AuthMethodSearch:

Search string to find the target AuthenticationMethod

AuthMethodID:

Unique ID that maps to the target AuthenticationMethod - Supply AuthMethodID to skip any querying for target AuthenticationMethod

Get-VPASSQLAccounts : Optional Parameters

This command has NO optional parameters

Get-VPASSQLPlatforms : Optional Parameters

This command has NO optional parameters

Get-VPASSQLSafes : Optional Parameters

This command has NO optional parameters

Get-VPASSystemComponents : Optional Parameters

This command has NO optional parameters

Get-VPASSystemHealth : Optional Parameters

This command has NO optional parameters

Get-VPASUsagePlatformDetails : Optional Parameters

This command has NO optional parameters

Get-VPASVaultDetails : Optional Parameters

This command has NO optional parameters

Get-VPASVaultVersion : Optional Parameters

This command has NO optional parameters

Import-VPASConnectionComponent : Optional Parameters

This command has NO optional parameters

Import-VPASPlatform : Optional Parameters

This command has NO optional parameters

Invoke-VPASAccountPasswordAction : Optional Parameters

newPass:

Provide a new password if the action is ChangeOnlyInVault or ChangeSetNew

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Invoke-VPASActivePSMSessionAction : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

ActiveSessionID:

Unique ID for the target ActiveSessionID - Provide this value to skip querying all ActiveSessions

Invoke-VPASAuditSafeTest : Optional Parameters

This command has NO optional parameters

Invoke-VPASCentralCredentialProvider : Optional Parameters

Folder:

A directory within a safe that the target account is located in - Default value: root

AIMIISAppPool:

IIS endpoint that the AIMWebService is deployed to - Default value: AIMWebService

CertificateTP:

Thumbprint of the certificate being used to make the call for applications configured with certificate authentication

Certificate:

Certificate being used to make the call for applications configured with certificate authentication

Reason:

Purpose for pulling the account, for auditing and master policy restriction

NoSSL:

If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Invoke-VPASCredentialProvider : Optional Parameters

Folder:

A directory within a safe that the target account is located in - Default value: root

Reason:

Purpose for pulling the account, for auditing and master policy restriction

Invoke-VPASMetricsAccounts : Optional Parameters

OutputDirectory:

Specify where the location for report output to be saved

HTMLChart:

Specify the HTML report type - Possible values: BarGraph, LineGraph, PieChart, ALL

DayRange:

Specify the date range for the selected metric report

AmtOfSets:

Specify the length of historic data to be included in the metric report

HideRawData:

Removes the RawData visual from the exported output - Helpful when exporting to a PDF or document to remove extra not needed information

Invoke-VPASMetricsCPM : Optional Parameters

OutputDirectory:

Specify where the location for report output to be saved

HTMLChart:

Specify the HTML report type - Possible values: BarGraph, LineGraph, PieChart, ALL

HideRawData:

Removes the RawData visual from the exported output - Helpful when exporting to a PDF or document to remove extra not needed information

Invoke-VPASMetricsPlatforms : Optional Parameters

OutputDirectory:

Specify where the location for report output to be saved

HTMLChart:

Specify the HTML report type - Possible values: BarGraph, LineGraph, PieChart, ALL

HideRawData:

Removes the RawData visual from the exported output - Helpful when exporting to a PDF or document to remove extra not needed information

Invoke-VPASMetricsProviders : Optional Parameters

OutputDirectory:

Specify where the location for report output to be saved

HTMLChart:

Specify the HTML report type - Possible values: BarGraph, LineGraph, PieChart, ALL

HideRawData:

Removes the RawData visual from the exported output - Helpful when exporting to a PDF or document to remove extra not needed information

Invoke-VPASMetricsPSM : Optional Parameters

OutputDirectory:

Specify where the location for report output to be saved

AmtOfSets:

Specify the length of historic data to be included in the metric report

HTMLChart:

Specify the HTML report type - Possible values: BarGraph, LineGraph, PieChart, ALL

AmtOfUsers:

Specify the amount of users to be included in the metric

HideRawData:

Removes the RawData visual from the exported output - Helpful when exporting to a PDF or document to remove extra not needed information

Invoke-VPASQuery : Optional Parameters

NoSSL:

If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Invoke-VPASReporting : Optional Parameters

OutputDirectory:

Where to place the newly generated report

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

WildCardSearch:

Treat the searchquery as a wildcard search (*searchquery*) instead of a single value

IncludePredefinedSafeMembers:

Include built in safe members when reporting on safe members

Confirm:

Skip the confirmation prompt to continue regardless on the size of the environment

Limit:

Upper estimate of the amount of the amount of safes in the environment - Round to the nearest 1000th to capture all safes

HideOutput:

Suppress any output to the console

Invoke-VPASUserLicenseReport : Optional Parameters

This command has NO optional parameters

New-VPASDPASetupScript : Optional Parameters

ExpirationPeriod:

Duration the installation script will be valid for in minutes (expiration value must be between 15 and 240) - Default value: 15 minutes

New-VPASIdentityGenerateUserPassword : Optional Parameters

CopyToClipboard:

The generated password will be copied to the clipboard

New-VPASPSMSession : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

OpenRDPFile:

Trigger the RDPFile to open by default, rather then just display the RDPFile contents

TargetServer:

Define the target server if the connection component prompts for a server - Commonly used for domain accounts connecting via PSM-RDP

Reason:

Define a reason for connecting for audit purposes

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Remove-VPASAccount : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASAccountFromAccountGroup : Optional Parameters

GroupID:

Unique ID that maps to the target AccountGroup - Supply GroupID to skip any querying for target AccountGroup

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

GroupName:

Unique target GroupName that will be used to query for the GroupID if no GroupID is passed - An account group is set of accounts that will have the same password synced across the entire group

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASAccountRequest : Optional Parameters

RequestedSafe:

Safe name that will be used to query for the target account if no AcctID is passed

RequestedPlatform:

PlatformID that will be used to query for the target account if no AcctID is passed

RequestedUsername:

Username that will be used to query for the target account if no AcctID is passed

RequestedAddress:

Address that will be used to query for the target account if no AcctID is passed

RequestedAcctID:

Unique ID that maps to a single account, passing this variable will skip query functions to find target account

RequestedReason:

Reason that will be used to query and find the target account request

requestID:

Unique ID that maps to a single account request, passing this variable will skip any query functions

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASAllDiscoveredAccounts : Optional Parameters

Confirm:

Skip the confirmation prompt confirming the removal of all discovered accounts

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASApplication : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASApplicationAuthentication : Optional Parameters

AuthType:

Define the type of the target authentication - Possible values: path, hash, osuser, machineaddress, certificateserialnumber

AuthValue:

Value to be removed from the target AppID

AuthID:

Unique ID that maps to the target application authentication - Supply the AuthID to skip any querying for target application authentication

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASAuthenticationMethod : Optional Parameters

AuthMethodSearch:

Search string to find the target AuthenticationMethod

AuthMethodID:

Unique ID that maps to the target AuthenticationMethod - Supply AuthMethodID to skip any querying for target AuthenticationMethod

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASDirectory : Optional Parameters

confirm:

Remove the confirmation prompt asking to confirm the deletion of the selected DirectoryID

Remove-VPASDPAPolicy : Optional Parameters

PolicyID:

UniqueID of the target policy in DPA

PolicyName:

Unique name of the target policy in DPA

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASDPAStrongAccount : Optional Parameters

StrongAccountID:

UniqueID of the target strong account in DPA

StrongAccountName:

Unique name of the target strong account in DPA

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASEPVGroup : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASEPVUser : Optional Parameters

Confirm:

Skip the confirmation prompt confirming the deletion/removal of an EPVUser

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASGroupPlatform : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASIdentityAdminSecurityQuestion : Optional Parameters

QuestionSearchQuery:

Search query to locate the target admin security question

QuestionID:

Unique target QuestionID mapping to the target admin security question - Supply the QuestionID to skip any querying for target admin security question

Confirm:

Skip the confirmation prompt confirming the removal of the admin security question

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASIdentityRole : Optional Parameters

RoleName:

Unique RoleName in Identity to query for target RoleID

RoleID:

Target RoleID that maps the target Role in Identity - Supply the RoleID to skip querying for the target Role

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASLinkedAccount : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Remove-VPASMemberEPVGroup : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASPlatform : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASRotationalPlatform : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASSafe : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASSafeMember : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASToken : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Remove-VPASUsagePlatform : Optional Parameters

WhatIf:

Run code simulation to see what is affected by running the command as well as any possible implications - This is a code simulation flag, meaning the command will NOT actually run

HideWhatIfOutput:

Suppress any code simulation output from the console

Reset-VPASEPVUserPassword : Optional Parameters

This command has NO optional parameters

Reset-VPASIdentityUserSecurityQuestions : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Set-VPASAuditSafeTest : Optional Parameters

SafeNamingConvention:

Define which safe to pull for the audit based on a search query

AmtMembers:

Define how many safe members will be included in the audit

CPMName:

Define the correct CPM that should be attached to every safe in the audit

IgnoreInternalSafes:

Define if the internal safes should be included in the audit - Internal safes such as System, VaultInternal, NotificationEngine, component safes, etc

Set-VPASIdentityUserState : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Set-VPASIdentityUserStatus : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Set-VPASLinkedAccount : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

Set-VPASSQLConnectionDetails : Optional Parameters

SQLServer:

Fully qualified domain name of the server that is hosting the SQL database that VPASModule is exporting data to

SQLDatabase:

Name of the database that VPASModule is exporting data to

SQLUsername:

Username of the SQL account that will be used to connect to the database - Not recommended to hardcode username/password in scripts, use credential providers if possible

SQLPassword:

Password of the SQL account that will be used to connect to the database - Not recommended to hardcode username/password in scripts, use credential providers if possible

AAM:

Select which method will be used to input credentials. HIGHLY recommended to utilize either CCP or CP - Possible values: CCP, CP, NONE

AppID:

Unique ApplicationID (or Application Name) that will be used by the credential provider(s) to retrieve credentials

Folder:

Folder location of the credential object being pulled via

SafeID:

SafeID that is holding the credential object being pulled via Credential Provider (CP) or Central Credential Provider (CCP)

ObjectName:

Unique ObjectName of the credential object being pulled via Credential Provider (CP) or Central Credential Provider (CCP)

AIMServer:

Fully qualified domain name of the AIMServer if Central Credential Provider (CCP) is being utilized

CertificateTP:

Certificate thumbprint that will be passed in the API call if ApplicationID has a certificate restriction

PasswordSDKPath:

File path of where the PasswordSDK is located to make the Credential Provider (CP) call

SkipConfirmation:

Remove the confirmation prompt asking to overwrite the connection details if they already exist

NoSSL:

If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Test-VPASIdentityUserLocked : Optional Parameters

Username:

Username that will be used to query for the target user in Identity if no UserID is passed

UserID:

Unique UserID that maps to the target User in Identity - Supply the UserID to skip any querying for the target User

Test-VPASSQLConnectionDetails : Optional Parameters

NoSSL:

If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Unlock-VPASExclusiveAccount : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

AdminUnlock:

Switch that will automatically unlock a locked account skipping the release worflow - This will be dependent on if user has UnlockAccounts safe permission

Update-VPASAccountFields : Optional Parameters

safe:

Safe name that will be used to query for the target account if no AcctID is passed

platform:

PlatformID that will be used to query for the target account if no AcctID is passed

username:

Username that will be used to query for the target account if no AcctID is passed

address:

Address that will be used to query for the target account if no AcctID is passed

AcctID:

Unique ID that maps to a single account, passing this variable will skip any query functions

CustomField:

Target property tag that will be updated

Update-VPASAuthenticationMethod : Optional Parameters

DisplayName:

Display value of the AuthenticationMethod

Enabled:

Specify if the AuthenticationMethod will be enabled - AuthenticationMethod will NOT appear if set to disabled - Possible values: TRUE, FALSE

MobileEnabled:

Allow the AuthenticationMethod to be visible on mobile - Possible values: TRUE, FALSE

LogoffURL:

Redirect link that EndUsers will funnel through on logoff

SecondFactorAuth:

Enable a second factor authentication - Possible values: cyberark, radius, ldap

SignInLabel:

Visual title of the AuthenticationMethod - This is what EndUsers will see

UsernameFieldLabel:

Visual tag for the Username box - This is what EndUsers will see

PasswordFieldLabel:

Visual tag for the Password box - This is what EndUsers will see

AuthMethodSearch:

Search string to find the target AuthenticationMethod

AuthMethodID:

Unique ID that maps to the target AuthenticationMethod - Supply AuthMethodID to skip any querying for target AuthenticationMethod

Update-VPASEPVGroup : Optional Parameters

This command has NO optional parameters

Update-VPASEPVUser : Optional Parameters

UpdateWorkStreet:

EPVUser new WorkStreet value

UpdateWorkCity:

EPVUser new WorkCity value

UpdateWorkState:

EPVUser new WorkState value

UpdateWorkZip:

EPVUser new WorkZip value

UpdateWorkCountry:

EPVUser new WorkCountry value

UpdateHomePage:

EPVUser new HomePage value

UpdateHomeEmail:

EPVUser new HomeEmail value

UpdateBusinessEmail:

EPVUser new BusinessEmail value

UpdateOtherEmail:

EPVUser new OtherEmail value

UpdateHomeNumber:

EPVUser new HomeNumber value

UpdateBusinessNumber:

EPVUser new BusinessNumber value

UpdateCellularNumber:

EPVUser new CellularNumber value

UpdateFaxNumber:

EPVUser new Faxnumber value

UpdatePagerNumber:

EPVUser new PagerNumber value

UpdateEnableUser:

Enable or Disable current state of EPVUser - Possible values: Enable, Disable

UpdateChangePassOnNextLogon:

Enable or Disable ChangePassOnNextLogon restriction - Possible values: Yes, No

UpdatePasswordNeverExpires:

Enable ot Disable PasswordNeverExpires restriction - Possible values: Yes, No

UpdateDescription:

EPVUser new Descripion value

UpdateLocation:

EPVUser new Location value

UpdateStreet:

EPVUser new Street value

UpdateCity:

EPVUser new City value

UpdateState:

EPVUser new State value

UpdateZip:

EPVUser new Zip value

UpdateCountry:

EPVUser new Country value

UpdateTitle:

EPVUser new Title value

UpdateOrganization:

EPVUser new Organization value

UpdateDepartment:

EPVUser new Department value

UpdateProfession:

EPVUser new Profession value

UpdateFirstName:

EPVUser new FirstName value

UpdateMiddleName:

EPVUser new MiddleName value

UpdateLastName:

EPVUser new LastName value

AddVaultAuthorization:

Add VaultAuthorization permissions in addition to current permissions to target EPVUser - Possible values: AddUpdateUsers, AddSafes, AddNetworkAreas, ManageDirectoryMapping, ManageServerFileCategories, AuditUsers, BackupAllSafes, RestoreAllSafes, ResetUsersPasswords, ActivateUsers

DeleteVaultAuthorization:

Delete specific existing VaultAuthorizations from target EPVUser - Possible values: AddUpdateUsers, AddSafes, AddNetworkAreas, ManageDirectoryMapping, ManageServerFileCategories, AuditUsers, BackupAllSafes, RestoreAllSafes, ResetUsersPasswords, ActivateUsers

Update-VPASIdentityCurrentUserPassword : Optional Parameters

This command has NO optional parameters

Update-VPASIdentityRole : Optional Parameters

RoleName:

Unique RoleName in Identity to query for target RoleID

RoleID:

Target RoleID that maps the target Role in Identity - Supply the RoleID to skip querying for the target Role

Update-VPASPSMSettingsByPlatformID : Optional Parameters

ConnectionComponentID:

Unique ConnectionComponentID that will be added or removed

Action:

Which action will be taken on the updated fields - Possible values: ADD, REMOVE

PSMServerID:

Unique target PSMServerID that will be added or removed

Update-VPASSafe : Optional Parameters

This command has NO optional parameters

Update-VPASSafeMember : Optional Parameters

AllPerms:

Enables all safe permissions

AllAccess:

Enables all Access safe permissions (UseAccounts, RetrieveAccounts, ListAccounts)

AllAccountManagement:

AllMonitor:

Enables all Monitor safe permissions (ViewAuditLog, ViewSafeMembers)

AllSafeManagement:

Enables all SafeManagement safe permissions (ManageSafe, ManageSafeMembers, BackupSafe)

AllWorkflow:

Enables all Workflow safe permissions (RequestsAuthorizationLevel(1), AccessWithoutConfirmation)

AllAdvanced:

Enables all Advanced safe permissions (CreateFolders, DeleteFolders, MoveAccountsAndFolders)

UseAccounts:

Gives the ability use accounts in a safe (click the connect button)

RetrieveAccounts:

Gives the ability to pull accounts credentials in a safe (click the Show/Copy buttons)

ListAccounts:

Gives the ability to view accounts in a safe

AddAccounts:

Gives the ability to add accounts in a safe

UpdateAccountContent:

Gives the ability to manually update accounts secrets in a safe

UpdateAccountProperties:

Gives the ability to update account properties in a safe (username field, address field, etc)

InitiateCPMAccountManagementOperations:

Gives the ability to trigger the CPM to run a change, verify, or reconcile on accounts in a safe

SpecifyNextAccountContent:

Gives the ability to specify what the next password the CPM will push to accounts in a safe

RenameAccounts:

Gives the ability to modify the ObjectName of accounts in a safe

DeleteAccounts:

Gives the ability to delete accounts from a safe

UnlockAccounts:

Gives the ability to unlock or check-in locked account on someone else's behalf in a safe

ManageSafe:

Gives the ability to modify safe details (DaysRetention, VersionRetention, Description, etc)

ManageSafeMembers:

Gives the ability to add, remove, modify safe members on a safe

BackupSafe:

Gives the ability to backup a safe

ViewAuditLog:

Gives the ability to view the activities performed on accounts in a safe

ViewSafeMembers:

Gives the ability to view safe members on a safe

AccessWithoutConfirmation:

Gives the ability to access the safe without needing confirmation from an approver

CreateFolders:

Gives the ability to create folders in a safe

DeleteFolders:

Gives the ability to delete folders from a safe

MoveAccountsAndFolders:

Gives the ability to move accounts and folders from one safe to another

RequestsAuthorizationLevel1:

Gives the ability to approve or deny users from using an account (Level1) in a safe

RequestsAuthorizationLevel2:

Gives the ability to approve or deny users from using an account (Level2) in a safe

SafePermissionHashTable:

Hashtable that contains the set of safe permissions to be applied to a specific safe member. - Hashtable has priority over the safe permission flags that are passed

Watch-VPASActivePSMSession : Optional Parameters

SearchQuery:

Search string to find target resource via username, address, safe, platform, etc. - Comma separated for multiple fields, or to search all pass a blank value like so: " "

ActiveSessionID:

Unique ID that maps to the target ActiveSession - Supply the ActiveSessionID to skip any querying to find the target ActiveSession

OpenRDPFile:

Trigger the RDPFile to open by default, rather then just display the RDPFile contents

VpasModule

DISCLAIMER

Step1 - Authentication:

Step2 - Select Command:

Step3 - Generate Script:

Step4 - Display Script:

***DISCLAIMER***

Step1 - Authentication:

Step2 - Select Command:

Step3 - Generate Script:

Step4 - Display Script:

DISCLAIMER