Publish-BackupStatus¶

Synopsis¶

Request and publish the backup status.

Syntax¶

All-WorkloadDomains¶

Publish-BackupStatus [-server] <String> [-user] <String> [-pass] <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]

Specific-WorkloadDomain¶

Publish-BackupStatus [-server] <String> [-user] <String> [-pass] <String> [-workloadDomain] <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]

Description¶

The Publish-BackupStatus cmdlet checks the backup status for SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report. The cmdlet connects to the SDDC Manager using the -server, -user, and -pass values:

Validates that network connectivity is available to the SDDC Manager instance.
Performs checks on the backup status and outputs the results.
outputJson parameter takes in name of the folder to save the json. Filename is autogenerated.

Examples¶

Example 1¶

Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains

This example will publish the backup status for the SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance.

Example 2¶

Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly

This example will publish the backup status for the SDDC Manager, vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance but only reports issues.

Example 3¶

Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]

This example will publish the backup status for the vCenter instances, and NSX Local Manager clusters in the specified workload domain.

Example 4¶

Publish-BackupStatus -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -outputJson [report_path]

This example will generate a json for the backup status for the vCenter instances, and NSX Local Manager clusters in a VMware Cloud Foundation instance and saves it under the specified report path with filename <timestamp>-backup-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

-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.