Skip to content

Cmdlet Reference

Complete parameter reference for all public S2DCartographer cmdlets.


Orchestration

CmdletPurpose
Invoke-S2DCartographerFull pipeline — connect, collect, analyze, and generate all reports in one call
Invoke-S2DCapacityWhatIfModel capacity impact of hardware changes without touching the live cluster

Connection

CmdletPurpose
Connect-S2DClusterEstablish an authenticated session to the cluster
Disconnect-S2DClusterRelease the active session

Collectors

CmdletPurpose
Get-S2DPhysicalDiskInventoryInventory all physical disks with health, capacity, and wear data
Get-S2DStoragePoolInfoStorage pool configuration, capacity allocation, and overcommit status
Get-S2DVolumeMapVolume resiliency type, footprint, and provisioning detail
Get-S2DCacheTierInfoCache tier configuration, binding ratio, and health
Get-S2DCapacityWaterfall7-stage theoretical capacity waterfall
Get-S2DHealthStatusAll 11 health checks with pass/warn/fail results

Output

CmdletPurpose
New-S2DReportGenerate HTML, Word, PDF, Excel, JSON, or CSV reports
New-S2DDiagramGenerate SVG diagrams

Utilities

CmdletPurpose
ConvertTo-S2DCapacityConvert a capacity value to a dual-unit TiB/TB object

Released under the MIT License.