Cesivi PowerShell Module — Cmdlet Reference¶

Module: Cesivi.PowerShell v3.2.0 Total Cmdlets: 175 (the module manifest Cesivi.PowerShell.psd1 is the authoritative export list) Framework: .NET 10.0 / PowerShell 7.0+

Common Parameters¶

All CS* cmdlets inherit from CSServerCmdlet and support:

Parameter	Type	Required	Description
`-Server`	string	No	Server URL (default: `$env:CESIVI_SERVER_URL` or `http://localhost:5000`)
`-Token`	string	No	Bearer token for authentication
`-Credential`	PSCredential	No	Credentials for Basic/NTLM authentication

Categories (26)¶

Site (4 cmdlets)¶

Cmdlet	Description
`Get-CSSite`	Get site collection properties
`New-CSSite`	Create a new site collection
`Set-CSSite`	Update site collection properties
`Remove-CSSite`	Delete a site collection

Web (4 cmdlets)¶

Cmdlet	Description
`Get-CSWeb`	Get web (subsite) properties
`New-CSWeb`	Create a new web
`Set-CSWeb`	Update web properties
`Remove-CSWeb`	Delete a web

List (4 cmdlets)¶

Cmdlet	Description
`Get-CSList`	Get list properties
`New-CSList`	Create a new list
`Set-CSList`	Update list properties
`Remove-CSList`	Delete a list

ListItem (4 cmdlets)¶

Cmdlet	Description
`Get-CSListItem`	Get list items
`New-CSListItem`	Create a new list item
`Set-CSListItem`	Update list item properties
`Remove-CSListItem`	Delete a list item

File (11 cmdlets)¶

Cmdlet	Description
`Get-CSFile`	Get file properties or content
`New-CSFile`	Upload a new file
`Set-CSFile`	Update file properties
`Remove-CSFile`	Delete a file
`Copy-CSFile`	Copy a file to a new location
`Set-CSFileCheckedOut`	Check out a file
`Set-CSFileCheckedIn`	Check in a file with comment
`Publish-CSFile`	Publish a file (major version)
`Unpublish-CSFile`	Unpublish a file
`Approve-CSFile`	Approve a file
`Deny-CSFile`	Reject/deny a file

Folder (7 cmdlets)¶

Cmdlet	Description
`Get-CSFolder`	Get folder properties
`New-CSFolder`	Create a new folder
`Remove-CSFolder`	Delete a folder
`Move-CSFolder`	Move a folder to a new location
`Copy-CSFolder`	Copy a folder to a new location
`Set-CSFolder`	Update folder properties
`Rename-CSFolder`	Rename a folder

User (4 cmdlets)¶

Cmdlet	Description
`Get-CSUser`	Get site user(s)
`New-CSUser`	Ensure/add a user to the site
`Set-CSUser`	Update user properties
`Remove-CSUser`	Remove a user from the site

Group (6 cmdlets)¶

Cmdlet	Description
`Get-CSGroup`	Get SharePoint group(s)
`New-CSGroup`	Create a new group
`Set-CSGroup`	Update group properties
`Remove-CSGroup`	Delete a group
`Add-CSGroupMember`	Add a user to a group
`Remove-CSGroupMember`	Remove a user from a group

Field (4 cmdlets)¶

Cmdlet	Description
`Get-CSField`	Get field definitions
`New-CSField`	Create a new field
`Set-CSField`	Update field properties
`Remove-CSField`	Delete a field

ContentType (4 cmdlets)¶

Cmdlet	Description
`Get-CSContentType`	Get content types
`New-CSContentType`	Create a new content type
`Set-CSContentType`	Update content type properties
`Remove-CSContentType`	Delete a content type

Feature (3 cmdlets)¶

Cmdlet	Description
`Get-CSFeature`	Get activated features
`Enable-CSFeature`	Activate a feature
`Disable-CSFeature`	Deactivate a feature

Solution (5 cmdlets)¶

Cmdlet	Description
`Get-CSSolution`	Get installed solutions
`Add-CSSolution`	Upload a solution package
`Install-CSSolution`	Activate/install a solution
`Uninstall-CSSolution`	Deactivate/uninstall a solution
`Remove-CSSolution`	Delete a solution

Permission (8 cmdlets)¶

Cmdlet	Description
`Get-CSRoleDefinition`	Get role definitions (Full Control, Contribute, etc.)
`Get-CSRoleAssignment`	Get role assignments for a securable object
`New-CSRoleAssignment`	Assign a role to a user/group
`Remove-CSRoleAssignment`	Remove a role assignment
`Set-CSPermissionInheritance`	Break or reset role inheritance
`Test-CSPermission`	Check if user has specific permissions
`Get-CSEffectivePermission`	Get effective permissions for a user
`Get-CSPermissionCollection`	Get all permissions for an object

View (4 cmdlets)¶

Cmdlet	Description
`Get-CSView`	Get list views
`New-CSView`	Create a new view
`Set-CSView`	Update view properties
`Remove-CSView`	Delete a view

Version (4 cmdlets)¶

Cmdlet	Description
`Get-CSFileVersion`	Get file version history
`Restore-CSFileVersion`	Restore a specific version
`Remove-CSFileVersion`	Delete a specific version
`Remove-CSFileVersionHistory`	Delete all versions (keep current)

RecycleBin (4 cmdlets)¶

Cmdlet	Description
`Get-CSRecycleBinItem`	List items in recycle bin
`Restore-CSRecycleBinItem`	Restore an item from recycle bin
`Remove-CSRecycleBinItem`	Permanently delete from recycle bin
`Clear-CSRecycleBin`	Empty the recycle bin

Search (3 cmdlets)¶

Cmdlet	Description
`Invoke-CSSearch`	Execute a KQL search query
`Get-CSSearchSuggestion`	Get search suggestions for a query prefix
`Get-CSSearchSchema`	Get search managed properties

Taxonomy (9 cmdlets)¶

Cmdlet	Description
`Get-CSTermStore`	Get term store(s)
`Get-CSTermGroup`	Get term groups
`Get-CSTermSet`	Get term sets
`Get-CSTerm`	Get terms
`New-CSTermSet`	Create a new term set
`New-CSTerm`	Create a new term
`Set-CSTerm`	Update term properties
`Remove-CSTermSet`	Delete a term set
`Remove-CSTerm`	Delete a term

UserProfile (3 cmdlets)¶

Cmdlet	Description
`Get-CSUserProfile`	Get user profile properties
`Set-CSUserProfile`	Set user profile properties
`Get-CSUserProfileProperty`	Get a specific profile property

Alert (4 cmdlets)¶

Cmdlet	Description
`Get-CSAlert`	Get alerts for current or specified user
`New-CSAlert`	Create a new alert
`Set-CSAlert`	Update alert properties
`Remove-CSAlert`	Delete an alert

Webhook (4 cmdlets)¶

Cmdlet	Description
`Get-CSWebhook`	Get webhook subscriptions for a list
`New-CSWebhook`	Create a webhook subscription
`Set-CSWebhook`	Update webhook properties
`Remove-CSWebhook`	Delete a webhook subscription

Workflow (6 cmdlets)¶

Cmdlet	Description
`Get-CSWorkflowDefinition`	Get workflow definitions
`New-CSWorkflowDefinition`	Create a workflow definition
`Remove-CSWorkflowDefinition`	Delete a workflow definition
`Get-CSWorkflowInstance`	Get workflow instances
`Start-CSWorkflow`	Start a workflow on a list item
`Stop-CSWorkflow`	Cancel/terminate a workflow instance

Cmdlet	Description
`Get-CSNavigationNode`	Get quick launch or top navigation nodes
`New-CSNavigationNode`	Add a navigation node
`Set-CSNavigationNode`	Update navigation node properties
`Remove-CSNavigationNode`	Delete a navigation node

CustomAction (3 cmdlets)¶

Cmdlet	Description
`Get-CSCustomAction`	Get custom actions for web/site
`New-CSCustomAction`	Add a custom action
`Remove-CSCustomAction`	Delete a custom action

EventReceiver (3 cmdlets)¶

Cmdlet	Description
`Get-CSEventReceiver`	Get event receivers for a list/web
`New-CSEventReceiver`	Register an event receiver
`Remove-CSEventReceiver`	Unregister an event receiver

Admin (3 cmdlets)¶

Cmdlet	Description
`Get-CSStorageMetrics`	Get storage usage for site/web/list
`Export-CSStorage`	Export storage as ZIP/7z archive
`Import-CSStorage`	Import storage from ZIP/7z archive

Farm — WebApplication & ContentDatabase (10 cmdlets) — PLAN-1795¶

The native primary farm-admin surface (the Microsoft.SharePoint.PowerShell analogue). FarmAdmin-gated; thin clients over /_admin/webapps. Cesivi-noun aliases (*-CesiviWebApplication / *-CesiviContentDatabase) per DESIGN §2.11.1. The PnP module (*-PnPWebApplication / *-PnPContentDatabase) is the secondary surface.

Cmdlet	Alias	Description
`Get-CSWebApplication`	`Get-CesiviWebApplication`	List web applications, or get one by `-Identity`
`New-CSWebApplication`	`New-CesiviWebApplication`	Create a web application (host bindings, managed paths, storage backend)
`Set-CSWebApplication`	`Set-CesiviWebApplication`	Patch a web application (only supplied fields change)
`Remove-CSWebApplication`	`Remove-CesiviWebApplication`	Delete a web application (blocked for Default / while owning SCs)
`Get-CSContentDatabase`	`Get-CesiviContentDatabase`	List content databases (all / per-WA / one by id; auto-resolves owning WA)
`New-CSContentDatabase`	`New-CesiviContentDatabase`	Add a content database to a web application (optional `-CreatePhysicalDatabase`)
`Set-CSContentDatabase`	`Set-CesiviContentDatabase`	Patch a content database (status, caps, name, connection)
`Remove-CSContentDatabase`	`Remove-CesiviContentDatabase`	Remove a content database (blocked while sites pinned / last / default)
`Backup-CSContentDatabase`	`Backup-CesiviContentDatabase`	Back up a content database's physical database via native tooling
`Restore-CSContentDatabase`	`Restore-CesiviContentDatabase`	Restore a content database's physical database from a backup

Quick Start¶

# Load the module
Import-Module ./Cesivi.PowerShell/bin/Debug/net10.0/Cesivi.PowerShell.dll

# Set default server URL
$env:CESIVI_SERVER_URL = "http://localhost:5000"

# List all available cmdlets
Get-Command -Module Cesivi.PowerShell

# Basic operations
Get-CSSite
Get-CSList
Get-CSListItem -List "Documents"

# Search
Invoke-CSSearch -Query "budget report" -RowLimit 10

# Permissions
Get-CSRoleDefinition
Test-CSPermission -List "Documents" -PermissionKind ViewListItems

# Taxonomy
Get-CSTermStore
Get-CSTermGroup -TermStoreId "00000000-0000-0000-0000-000000000000"

Last Updated: 2026-02-12 Module Version: 3.0.0 (171 cmdlets, 26 categories)