For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quick reference guide

The following code snippet shows the basic search, get, create and delete operations that are possible with the module

# Import the module
Import-Module LithnetRMA;

# Connect to the MIM service instance
# (in PowerShell 7 use pipe://mim-service, or rmc://mim-service on Linux and macOS)
Set-ResourceManagementClient -BaseAddress http://mim-service:5725;

# Get a user by its account name
$obj = Get-Resource -ObjectType Person -AttributeName AccountName -AttributeValue ryan;

# Write all the attributes of the user to the screen
Write-Host $obj;

# Set a new value for the JobTitle attribute
$obj.JobTitle = "Tester";

# Save the changes to the Resource Management Service
Save-Resource $obj

# Search for a set
Search-Resources -XPath "/Set[DisplayName = 'Administrators']"

# Search for a set and return all attributes in the set object type
$set = Search-Resources -XPath "/Set[DisplayName = 'Administrators']" -ExpectedObjectClass Set
Write-Host $set

# Search for a set and return only the computed member and explicit member attributes in the set object type
Search-Resources -XPath "/Set[DisplayName = 'Administrators']" -AttributesToGet @("ComputedMember", "ExplicitMember")

# Delete a resource by a known ID
Remove-Resource 'cacfb5f3-4924-4b56-89ee-b6b0de3e36d5'

# Remove a resource by its reference using the pipeline
Get-Resource Person AccountName testuser | Remove-Resource

# Create a new user
$newObject = New-Resource -ObjectType Person
$newObject.AccountName = "testuser";
Save-Resource $newObject

# Get pending approvals
$pendingApprovals = Get-ApprovalRequest -Status Pending

# Approve pending approvals
Get-ApprovalRequest -Status Pending | Set-PendingApprovalRequest -Decision Approve -Reason "I said so!"

# Reject pending approvals
Get-ApprovalRequest -Status Pending | Set-PendingApprovalRequest -Decision Reject -Reason "I said so!"

Last updated