Documentation can be found at http://venafitppps.readthedocs.io or by using built-in PowerShell help. Every effort has been made to document each parameter and provide good examples.
| OS | PowerShell Version Tested | Status |
|---|---|---|
| Windows | 5.1 | Working! |
| Windows | Core 6.2.3 | Working! |
| MacOS | Core 6.2.3 | Working! |
| Linux (Ubuntu 18.04) | Core 6.2.3 | Working! |
After loading the module, create a new session with
$cred = Get-Credential
New-TppSession -ServerUrl 'https://venafi.mycompany.com' -Credential $credbefore calling any functions. This will create a session which will be used by default in other functions. You can also use integrated authentication, simply exclude the Credential.
One of the easiest ways to get started is to use Find-TppObject:
$allPolicy = Find-TppObject -Path '\ved\policy' -RecursiveThis will return all objects in the Policy folder. You can also search from the root folder, \ved.
To find a certificate object, not retrieve an actual certificate, use:
$cert = Find-TppCertificate -Limit 1Check out the parameters for Find-TppCertificate as there's an extensive list to search on.
Now you can take that certificate 'TppObject' and find all log entries associated with it:
$cert | Read-TppLogYou can also have multiple sessions at once, either to the same server with different credentials or different servers. This can be helpful to determine the difference between what different users can access or perhaps compare folder structures across environments. The below will compare the objects one user can see vs. another.
# assume you've created 1 session already as shown above...
$user2Cred = Get-Credential # specify credentials for a different/limited user
# get a session as user2 and save the session in a variable
$user2Session = New-TppSession -ServerUrl 'https://venafi.mycompany.com' -Credential $user2Cred -PassThru
# get all objects in the Policy folder for the first user
$all = Find-TppObject -Path '\ved\policy' -Recursive
# get all objects in the Policy folder for user2
$all2 = Find-TppObject -Path '\ved\policy' -Recursive -TppSession $user2Session
Compare-Object -ReferenceObject $all -DifferenceObject $all2 -Property PathPlease feel free to log an issue for any new features you would like, bugs you come across, or just simply a question. I am happy to have people contribute to the codebase as well.