Publish-StorageCapacityHealth¶
Synopsis¶
Request and publish the storage capacity status.
Syntax¶
All-WorkloadDomains¶
Publish-StorageCapacityHealth [-server] <String> [-user] <String> [-pass] <String> [-localUser] <String> [-localPass] <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
Specific-WorkloadDomain¶
Publish-StorageCapacityHealth [-server] <String> [-user] <String> [-pass] <String> [-localUser] <String> [-localPass] <String> [-workloadDomain] <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
Description¶
The Publish-StorageCapacityHealth
cmdlet checks the storage usage status for SDDC Manager, vCenter, datastores and ESX hosts, in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report or plain text to console.
The cmdlet connects to the SDDC Manager using the -server
, -user
, -pass
, -localUser
, and -localPass
values:
- Validates the network connectivity and authentication to the SDDC Manager instance.
- Performs checks on the storage usage status and outputs the results.
Examples¶
Example 1¶
Publish-StorageCapacityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_user_password] -allDomains
This example will publish storage usage status for SDDC Manager, vCenter instances, ESX hosts, and datastores in a VMware Cloud Foundation instance.
Example 2¶
Publish-StorageCapacityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_user_password] -allDomains -failureOnly
This example will publish storage usage status for SDDC Manager, vCenter instances, ESX hosts, and datastores in a VMware Cloud Foundation instance but only reports issues.
Example 3¶
Publish-StorageCapacityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_user_password] -workloadDomain [workload_domain_name]
This example will publish storage usage status for a specified workload domain in a VMware Cloud Foundation instance.
Example 4¶
Publish-StorageCapacityHealth -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -localUser [local_username] -localPass [local_user_password] -workloadDomain [workload_domain_name] -outputJson [report_path]
This example will publish storage usage status for a specific workload domain in a VMware Cloud Foundation instance and saves it as JSON under the specified report path with filename <timestamp>-storagecapacityhealth-status.json
.
Parameters¶
-server¶
The fully qualified domain name of the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-user¶
The username to authenticate to the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pass¶
The password to authenticate to the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-localUser¶
The username to authenticate to the SDDC Manager appliance as a local user.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-localPass¶
The password to authenticate to the SDDC Manager appliance as a local user.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-allDomains¶
Switch to run health checks across all workload domains.
Type: SwitchParameter
Parameter Sets: All-WorkloadDomains
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-workloadDomain¶
The name of the workload domain to run against.
Type: String
Parameter Sets: Specific-WorkloadDomain
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-failureOnly¶
Switch to only output issues to the report.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-outputJson¶
The path to save the output as a JSON file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Common Parameters¶
This cmdlet supports the common parameters: -Debug
, -ErrorAction
, -ErrorVariable
, -InformationAction
, -InformationVariable
, -OutVariable
, -OutBuffer
, -PipelineVariable
, -Verbose
, -WarningAction
, and -WarningVariable.
For more information, see about_CommonParameters.