Skip to content

Set-IntersightApplianceBackupPolicy.md

Latest commit

 

History

History
336 lines (253 loc) · 8.1 KB

Set-IntersightApplianceBackupPolicy.md

File metadata and controls

336 lines (253 loc) · 8.1 KB
external help file Intersight.PowerShell.dll-Help.xml
Module Name Intersight.PowerShell
online version
schema 2.0.0

Set-IntersightApplianceBackupPolicy

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightApplianceBackupPolicy [-Account< IamAccountRelationship>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-Filename< string>][-ManualBackup< bool>][[-Moid]< string>][-Password< string>][-Protocol< ApplianceBackupPolicy.ProtocolEnum>][-RemoteHost< string>][-RemotePath< string>][-RemotePort< long>][-RetentionCount< long>][-RetentionPolicyEnabled< bool>][-Schedule< OnpremSchedule>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Username< string>][-IfMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'ApplianceBackupPolicy' resource.

PARAMETERS

-Account

A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: IamAccountRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Filename

Backup filename to backup or restore.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ManualBackup

Backup mode of the appliance. Automatic backups of the appliance are not initiated if this property is set to 'true' and the backup schedule field is ignored.

Type: bool
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Moid

The unique identifier of this Managed Object instance.

Type: string
Parameter Sets: (All)
Aliases:

Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Password

Password to authenticate the file server.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Protocol

Communication protocol used by the file server (e.g. scp, sftp, or CIFS).\n* scp - Secure Copy Protocol (SCP) to access the file server.\n* sftp - SSH File Transfer Protocol (SFTP) to access file server.\n* cifs - Common Internet File System (CIFS) Protocol to access file server.

Type: ApplianceBackupPolicy.ProtocolEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RemoteHost

Hostname of the remote file server.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RemotePath

File server directory or share name to copy the file.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RemotePort

Remote TCP port on the file server (e.g. 22 for scp).

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RetentionCount

The number of backups before earliest backup is overwritten. Requires cleanup policy to be enabled.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RetentionPolicyEnabled

If backup rotate policy is set, older backups will automatically be overwritten. The number of backups before overwriting is defined by the retentionCount property.

Type: bool
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Schedule

Schedule to create a backup of the Intersight Appliance. Manualbackup field must be set to 'false' for this schedule to be active.

Note :- Use Initialize-IntersightOnpremSchedule to create the object of complex type OnpremSchedule

Type: OnpremSchedule
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Tags

Note :- Use Initialize-IntersightMoTag to create the object of complex type MoTag

Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Username

Username to authenticate the fileserver.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-IfMatch

For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.

Type: String
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Set-IntersightApplianceBackupPolicy

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightApplianceBackupPolicy

Initialize-IntersightMoVersionContext

Initialize-IntersightOnpremSchedule

New-IntersightApplianceBackupPolicy