Skip to content

Cmdlet Reference

Complete parameter reference for all public S2DCartographer cmdlets.


Orchestration

Cmdlet Purpose
Invoke-S2DCartographer Full pipeline — connect, collect, analyze, and generate all reports in one call
Invoke-S2DCapacityWhatIf Model capacity impact of hardware changes without touching the live cluster

Connection

Cmdlet Purpose
Connect-S2DCluster Establish an authenticated session to the cluster
Disconnect-S2DCluster Release the active session

Collectors

Cmdlet Purpose
Get-S2DPhysicalDiskInventory Inventory all physical disks with health, capacity, and wear data
Get-S2DStoragePoolInfo Storage pool configuration, capacity allocation, and overcommit status
Get-S2DVolumeMap Volume resiliency type, footprint, and provisioning detail
Get-S2DCacheTierInfo Cache tier configuration, binding ratio, and health
Get-S2DCapacityWaterfall 7-stage theoretical capacity waterfall
Get-S2DHealthStatus All 11 health checks with pass/warn/fail results

Output

Cmdlet Purpose
New-S2DReport Generate HTML, Word, PDF, Excel, JSON, or CSV reports
New-S2DDiagram Generate SVG diagrams

Utilities

Cmdlet Purpose
ConvertTo-S2DCapacity Convert a capacity value to a dual-unit TiB/TB object