Commit eb17b90

Title: Edit-MBSAPIAdministrator HeadTitle: Edit-MBSAPIAdministrator Meta: 'Edit-MBSAPIAdministrator' RedirectUrl: ''

Edit-MBSAPIAdministrator

Changes properties of an existing MBS admin


Edit-MBSAPIAdministrator
		[-AdminID] <String>
		[[-FirstName] <String>]
		[[-LastName] <String>]
		[[-Companies] <String[]>]
		[[-Enabled] <Boolean>]
		[[-Password] <SecureString>]
		[[-ProfileName] <String>]
		[-PermissionsModels] <AdministratorPermission>
		[[-AccessToCompaniesMode] {SpecifiedCompanies | AllCompanies}]
		[[-AccountType] {Undefined | InternalAccount | ExternalAccount}]
		[<CommonParameters>]

Description

Calls the PUT api/Administrators API to edit properties of an existing MBS administrator

Examples

Example 1:

PS C:\> Edit-MBSAPIAdministrator -ProfileName ao -AdminID 0b7e0a79-78e9-493e-af72-764f21960b05 -password (ConvertTo-SecureString -force -asplaintext 'Changed') -FirstName admin -LastName adminson -Enabled $true -PermissionsModels (New-MBSAPIAdministratorPermission -EnableUndefinedPermissions) -AccessToCompaniesMode SpecifiedCompanies -Companies 'DemoCompany'

Example 2: Note: If the administrator initially has access to all companies and you want to assign specific companies to him, parameter '-AccessToCompaniesMode SpecifiedCompanies' is needed to be explicitly specified.

PS C:\> Get-MBSAPIAdministrator -ProfileName ao -AdminID 0b7e0a79-78e9-493e-af72-764f21960b05 | Edit-MBSAPIAdministrator -AccessToCompaniesMode SpecifiedCompanies -Companies 'DemoCompany','NewCompany' -ProfileName ao

Parameters

-AdminID

ID of the admin that you are editing. Use Get-MBSAPIAdministrator to determine


Type	String
Required:	true
Position:	1
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-FirstName

First Name


Type	String
Required:	false
Position:	2
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-LastName

Last name


Type	String
Required:	false
Position:	3
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Companies

List of companies the admin should have access to


Type	String[]
Required:	false
Position:	4
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Enabled

Whether the admin is to be enabled.


Type	Boolean
Required:	false
Position:	5
Default value:	True
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Password

The administrator's password.


Type	SecureString
Required:	false
Position:	6
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)


Type	String
Required:	false
Position:	7
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-PermissionsModels

Permissions for the administrator. Use New-MBSAPIAdministratorPermission to create an object. Valid permissions can be found here: https://api.mspbackups.com/Help/ResourceModel?modelName=PermissionsModels


Type	AdministratorPermission
Required:	true
Position:	8
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-AccessToCompaniesMode

Assign the administrator to specified companies (in Companies parameter) or to all companies. Accepted values: SpecifiedCompanies, AllCompanies (https://mspbackups.com/mbsapi/Help/ResourceModel?modelName=AccessToCompaniesEnum))

Type AccessToCompaniesMode

Required: false

Position: 9

Default value: SpecifiedCompanies

Accept pipeline input: true (ByPropertyName)

Accept wildcard characters: false


Type	AccessToCompaniesMode
Required:	false
Position:	9
Default value:	SpecifiedCompanies
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-AccountType

If set to 'Internal' then access to an employee inside company is provided. If set to 'External' then access to any third party, such as a customer, is provided. This field can be empty for backward compatibility.


Type	AdministratorAccountType
Required:	false
Position:	10
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject

Outputs

System.Management.Automation.PSCustomObject

Notes

Author: MSP360 Onboarding Team

Title: Edit-MBSAPICompany HeadTitle: Edit-MBSAPICompany Meta: 'Edit-MBSAPICompany' RedirectUrl: ''

Edit-MBSAPICompany

Change MBS company properties.


Edit-MBSAPICompany
		[[-ID] <String>]
		[[-Name] <String>]
		[[-StorageLimit] <String>]
		[[-LicenseSettings] <String>]
		[[-DestinationID] <String[]>]
		[[-ProfileName] <String>]
		[<CommonParameters>]

Description

Calls PUT request to api/Companies

Examples

~~Example 1:~~

Example 1: Change the name, storage limit, and license setting for company with ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce

PS C:\> Edit-MBSAPICompany -ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce -Name "My Contoso" -StorageLimit 100000 -LicenseSettings 2 -ProfileName profile

Example 2: Change (overwrite) the destinations of a company with ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce

PS C:\> Edit-MBSAPICompany -ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce -DestinationID ((Get-MBSAPIStorageAccount -ProfileName profile).Destinations | Where-Object {$_.DestinationDisplayName -like "*Local*"}).DestinationID -ProfileName profile

Parameters

-ID

Company Id. Use Get-MBSAPICompany to list companies ID.


Type	String
Required:	false
Position:	1
Default value:
Accept pipeline input:	true (ByValue, ByPropertyName)
Accept wildcard characters:	false

-Name

Company name


Type	String
Required:	false
Position:	2
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-StorageLimit

Company backup limit. A negative value indicates the resource is unconstrained by a quota.


Type	String
Required:	false
Position:	3
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-LicenseSettings

Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool(Users activate paid licenses from the global pool automatically) 2 - Company Pool(Users can activate only limited number of paid licenses from the company pool)


Type	String
Required:	false
Position:	4
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-DestinationID

Backup storage destination ID. Multiple IDs can be specified.


Type	String[]
Required:	false
Position:	5
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)

Type String

Required: false

Position: 5

Default value:

Accept pipeline input: false

Accept wildcard characters: false


Type	String
Required:	false
Position:	6
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject String

Outputs

~~System.Management.Automation.PSCustomObject~~

String

Notes

Author: MSP360 Onboarding Team

Title: Edit-MBSAPIUserBackupDestination HeadTitle: Edit-MBSAPIUserBackupDestination Meta: 'Edit-MBSAPIUserBackupDestination' RedirectUrl: ''

Edit-MBSAPIUserBackupDestination

~~Add~~Edit a backup destination toof a user.


Edit-MBSAPIUserBackupDestination
		[-UserID] <String>
		[-AccountID] <String>
		[-ID] <String>
		[-Destination] <String>
		[-PackageID] <String>
		[[-ProfileName] <String>]
		[<CommonParameters>]

Description

Calls the PUT api/Destinations API to edit a backup destination of a user.

Examples

Example 1: PS C:> $Destionation1 = (Get-MBSAPIUserBackupDestination -profilename ao -useremail [email protected])[0]

PS C:> $~~Destionation2~~Destination2 = (Get-MBSAPIUserBackupDestination -profilename ao -useremail [email protected])[1] PS C:> $Destination2.pPackageID = $destination1.pPackageID PS C:> $Destination2 | Edit-MBSAPIUserBackupDestination -profilename ao -userid $~~userid.id~~MBSUser.ID

Change package of the attached backup destination.

PS C:\> $MBSUser = Get-MBSAPIUser -profilename ao | Where-Object {$_.email -eq '[email protected]'}
PS C:\> $UserID = Get-MBSAPIUsers -profilename ao | ? {$_.email -eq '[email protected]'}

Parameters

-UserID

ID of the user whose backup destination will be edited. Use Get-MBSAPIUser to determine.


Type	String
Required:	true
Position:	1
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-AccountID

The ID of the storage account that is to be edited. Use Get-MBSAPIUserBackupDestination or Get-MBSAPIStorageAccount to determine.


Type	String
Required:	true
Position:	2
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-ID

ID of the destination to be edited. Use ~~Get-MBSAPIStorageAccountDestination~~Get-MBSAPIUserBackupDestination to determine.


Type	String
Required:	true
Position:	3
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Destination

Name of the destination


Type	String
Required:	true
Position:	4
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-PackageID

ID of the storage limit (package) that is to be applied.


Type	String
Required:	true
Position:	5
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)


Type	String
Required:	false
Position:	6
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject

Outputs

System.Management.Automation.PSCustomObject

Notes

Author: MSP360 Onboarding Team

Title: New-MBSAPIAdministrator HeadTitle: New-MBSAPIAdministrator Meta: 'New-MBSAPIAdministrator' RedirectUrl: ''

New-MBSAPIAdministrator

Creates an Administrator for MBS


New-MBSAPIAdministrator
		[-Email] <String>
		[[-FirstName] <String>]
		[[-LastName] <String>]
		[[-Companies] <String[]>]
		[[-Enabled] <Boolean>]
		[-Password] <SecureString>
		[[-SendEmailInstruction] <Boolean>]
		[[-ProfileName] <String>]
		[-PermissionsModels] <AdministratorPermission>
		[[-AccessToCompaniesMode] {SpecifiedCompanies | AllCompanies}]
		[[-AccountType] {Undefined | InternalAccount | ExternalAccount}]
		[<CommonParameters>]

Description

Calls the POST api/Administrators API to create a new administrator according to the specified parameters.

Examples

Example 1:

PS C:\> New-MBSAPIAdministrator -Email '[email protected]' -Password (ConvertTo-SecureString -Force -asplaintext 'test') -SendEmailInstruction $false -FirstName admin -LastName adminson -Enabled $true -PermissionsModels (New-MBSAPIAdministratorPermission -EnableUndefinedPermissions) -AccessToCompaniesMode AllCompanies -ProfileName profile

Parameters

-Email

Email address of the administrator


Type	String
Required:	true
Position:	1
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-FirstName

First name of the administrator


Type	String
Required:	false
Position:	2
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-LastName

Last name of the administrator


Type	String
Required:	false
Position:	3
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Companies

List of companies the adminstrator will have access to.


Type	String[]
Required:	false
Position:	4
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Enabled

Whether the administrator should be enabled after creation


Type	Boolean
Required:	false
Position:	5
Default value:	True
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-Password

Password


Type	SecureString
Required:	true
Position:	6
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-SendEmailInstruction

Whether or not to send instructions to the new administrator


Type	Boolean
Required:	false
Position:	7
Default value:	False
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)


Type	String
Required:	false
Position:	8
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-PermissionsModels

Permissions for the administrator. Use New-MBSAPIAdministratorPermission to create an object. Valid permissions can be found here: https://api.mspbackups.com/Help/ResourceModel?modelName=PermissionsModels


Type	AdministratorPermission
Required:	true
Position:	9
Default value:
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-AccessToCompaniesMode

Assign the administrator to specified companies (in Companies parameter) or to all companies. Accepted values: SpecifiedCompanies, AllCompanies (https://mspbackups.com/mbsapi/Help/ResourceModel?modelName=AccessToCompaniesEnum))

Type AccessToCompaniesMode

Required: false

Position: 10

Default value: SpecifiedCompanies

Accept pipeline input: true (ByPropertyName)

Accept wildcard characters: false


Type	AccessToCompaniesMode
Required:	false
Position:	10
Default value:	SpecifiedCompanies
Accept pipeline input:	true (ByPropertyName)
Accept wildcard characters:	false

-AccountType

If set to 'Internal' then access to an employee inside company is provided. If set to 'External' then access to any third party, such as a customer, is provided. This field can be empty for backward compatibility.


Type	AdministratorAccountType
Required:	false
Position:	11
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject

Outputs

String

Notes

Author: MSP360 Onboarding Team

Title: New-MBSAPIAdministratorPermission HeadTitle: New-MBSAPIAdministratorPermission Meta: 'New-MBSAPIAdministratorPermission' RedirectUrl: ''

New-MBSAPIAdministratorPermission

Creates MBS.API.AdministratorPermission type object.


New-MBSAPIAdministratorPermission
		[[-Users] {None | Access}]
		[[-StorageLimit] {None | Access}]
		[[-Notification] {None | Access}]
		[[-OnlineAccess] {None | Access}]
		[[-Licenses] {None | Access}]
		[[-Billing] {None | Access}]
		[[-Monitiring] {None | Access}]
		[[-RemoteDeploy] {None | Access}]
		[[-RemoteManagment] {None | Access}]
		[[-HelpMarketing] {None | Access}]
		[[-AuditLog] {None | Access}]
		[[-PSA] {None | Access}]
		[[-Administrators] {None | Access}]
		[[-Rebranding] {None | Access}]
		[[-Storage] {None | Access}]
		[[-ADS] {None | Access}]
		[[-LicenseBuy] {None | Access}]
		[[-LicenseActivate] {None | Access}]
		[[-StorageUsage] {None | Access}]
		[[-CapacityReport] {None | Access}]
		[[-GoogleApps] {None | Access}]
		[[-Dashboard] {None | Access}]
		[[-Downloads] {None | Access}]
		[[-CloudRestore] {None | Access}]
		[[-EC2Snapshots] {None | Access}]
		[[-LicenseUsageHistory] {None | Access}]
		[[-BackupHistory] {None | Access}]
		[[-PurchaseHistory] {None | Access}]
		[[-UsersCreateEdit] {None | Access}]
		[[-UsersDelete] {None | Access}]
		[[-ManageCompanies] {None | Access}]
		[[-ManageImmutability] {None | Access}]
		[-EnableUndefinedPermissions]
		[<CommonParameters>]

Description

Returns AdministratorPermission type object

Examples

Example 1: Create object with administrator permissions that allow only to manage notifications, remote management, downloads, and backup history.

PS C:\> New-MBSAPIAdministratorPermission -Notification Access -RemoteManagement Access -Downloads Access -BackupHistory Access

Example 2: Create object with administrator permissions that enables all permissions except managing administrators and all actions related to licenses.

PS C:\> New-MBSAPIAdministratorPermission -Administrators None -Licenses None -LicenseBuy None -LicenseActivate None -LicenseUsageHistory None -EnableUndefinedPermissions

Example 3: Create object with administrator permissions that enables all permissions

PS C:\> New-MBSAPIAdministratorPermission -EnableUndefinedPermissions

Parameters

-Users

Permission for manage users


Type	AdministratorPermissionMode
Required:	false
Position:	1
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-StorageLimit

Permission for manage storage limit


Type	AdministratorPermissionMode
Required:	false
Position:	2
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Notification

Permission for manage notification


Type	AdministratorPermissionMode
Required:	false
Position:	3
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-OnlineAccess

Permission for manage Online Access


Type	AdministratorPermissionMode
Required:	false
Position:	4
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Licenses

Permission for manage Licenses


Type	AdministratorPermissionMode
Required:	false
Position:	5
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Billing

Permission for manage billing


Type	AdministratorPermissionMode
Required:	false
Position:	6
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Monitiring

Permission for manage monitoring


Type	AdministratorPermissionMode
Required:	false
Position:	7
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-RemoteDeploy

Permission for manage remote deploy


Type	AdministratorPermissionMode
Required:	false
Position:	8
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-RemoteManagment

Permission for manage remote management


Type	AdministratorPermissionMode
Required:	false
Position:	9
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-HelpMarketing

Permission for marketing and help


Type	AdministratorPermissionMode
Required:	false
Position:	10
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-AuditLog

Permission for manage AuditLog


Type	AdministratorPermissionMode
Required:	false
Position:	11
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-PSA

Permission for manage connectwise and autotask


Type	AdministratorPermissionMode
Required:	false
Position:	12
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Administrators

Permission for manage administrators


Type	AdministratorPermissionMode
Required:	false
Position:	13
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Rebranding

Permission for manage rebranding


Type	AdministratorPermissionMode
Required:	false
Position:	14
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Storage

Permission for manage storages


Type	AdministratorPermissionMode
Required:	false
Position:	15
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-ADS

Permission for manage AD Bridge


Type	AdministratorPermissionMode
Required:	false
Position:	16
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-LicenseBuy

Permission for buy licenses


Type	AdministratorPermissionMode
Required:	false
Position:	17
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-LicenseActivate

Permission for activate licenses


Type	AdministratorPermissionMode
Required:	false
Position:	18
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-StorageUsage

Permission for storage usages


Type	AdministratorPermissionMode
Required:	false
Position:	19
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-CapacityReport

Permission for capacity report


Type	AdministratorPermissionMode
Required:	false
Position:	20
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-GoogleApps

Permission for manage google apps


Type	AdministratorPermissionMode
Required:	false
Position:	21
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Dashboard

Permission for dashboard


Type	AdministratorPermissionMode
Required:	false
Position:	22
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Downloads

Show Downloads


Type	AdministratorPermissionMode
Required:	false
Position:	23
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-CloudRestore

Manage Cloud Restore


Type	AdministratorPermissionMode
Required:	false
Position:	24
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-EC2Snapshots

Manage EC2 Snapshots


Type	AdministratorPermissionMode
Required:	false
Position:	25
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-LicenseUsageHistory

License Usage History


Type	AdministratorPermissionMode
Required:	false
Position:	26
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-BackupHistory

Backup History


Type	AdministratorPermissionMode
Required:	false
Position:	27
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-PurchaseHistory

Purchase History


Type	AdministratorPermissionMode
Required:	false
Position:	28
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-UsersCreateEdit

Allowed to Create and Edit Users


Type	AdministratorPermissionMode
Required:	false
Position:	29
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-UsersDelete

Allowed to Delete Users


Type	AdministratorPermissionMode
Required:	false
Position:	30
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-ManageCompanies

Allowed to Manage companies

Type AdministratorPermissionMode

Required: false

Position: 31

Default value:

Accept pipeline input: false

Accept wildcard characters: false


Type	AdministratorPermissionMode
Required:	false
Position:	31
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-ManageImmutability

Allowed to Manage immutability


Type	AdministratorPermissionMode
Required:	false
Position:	32
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-EnableUndefinedPermissions

If set, all undefined permissions will be enabled (by default, undefined permissions are disabled)


Type	SwitchParameter
Required:	false
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

None

Outputs

MBS.API.AdministratorPermission

Notes

Author: MSP360 Onboarding Team

Title: New-MBSAPICompany HeadTitle: New-MBSAPICompany Meta: 'New-MBSAPICompany' RedirectUrl: ''

New-MBSAPICompany

Create MBS company.


New-MBSAPICompany
		[-Name] <String>
		[[-StorageLimit] <String>]
		[[-LicenseSettings] <String>]
		[[-DestinationID] <String[]>]
		[[-ProfileName] <String>]
		[<CommonParameters>]

Description

Calls POST request to api/Companies.

Examples

Example 1: Create company named Contoso with unlimited storage and Global licensing pool.

PS C:\> New-MBSAPICompany -Name Contoso -StorageLimit -1 -LicenseSettings 1 -ProfileName profile

Example 2: Create company named ComputerCompany with 1 Tb storage limit, Custom licensing pool and backup destinations that have display names containing "AWS" and "Local"

PS C:\> New-MBSAPICompany -Name ComputerCompany -StorageLimit 1073741824000 -LicenseSettings 0 -DestinationID ((Get-MBSAPIStorageAccount -ProfileName profile).Destinations | Where-Object {($_.DestinationDisplayName -like "*AWS*") -Or ($_.DestinationDisplayName -like "*Local*")}).DestinationID -ProfileName profile

Parameters

-Name

Company name


Type	String
Required:	true
Position:	1
Default value:
Accept pipeline input:	true (ByValue, ByPropertyName)
Accept wildcard characters:	false

-StorageLimit

Company backup limit. A negative value indicates the resource is unconstrained by a quota.


Type	String
Required:	false
Position:	2
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-LicenseSettings

Company license settings: 0 - Custom (Users have custom license settings) 1 - Global Pool(Users activate paid licenses from the global pool automatically) 2 - Company Pool(Users can activate only limited number of paid licenses from the company pool)


Type	String
Required:	false
Position:	3
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-DestinationID

Backup storage destination ID. Multiple IDs can be specified.


Type	String[]
Required:	false
Position:	4
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)

Type String

Required: false

Position: 4

Default value:

Accept pipeline input: false

Accept wildcard characters: false


Type	String
Required:	false
Position:	5
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject String

Outputs

String

Notes

Author: MSP360 Onboarding Team

Title: Remove-MBSAPICompany HeadTitle: Remove-MBSAPICompany Meta: 'Remove-MBSAPICompany' RedirectUrl: ''

Remove-MBSAPICompany

Remove MBS company by ID


Remove-MBSAPICompany
		[[-ID] <String>]
		[-Force]
		[[-ProfileName] <String>]
		[-WhatIf]
		[-Confirm]
		[<CommonParameters>]

Description

Calls DELETE request to api/Companies

Examples

~~Example 1: Company ce786a8f-46a7-4442-b4ab-f2e2f1d9858a successfully deleted~~
~~Remove company by ID in force mode (no confirmation)~~

Example 1: Remove company by ID in force mode (no confirmation)

PS C:\> Remove-MBSAPICompany -id ce786a8f-46a7-4442-b4ab-f2e2f1d9858a -Force -ProfileName MyProfile

~~Example 2: Are you sure you want to perform this action?~~
Performing the operation "Remove-MBSAPICompany" on target "Removing company with ID: ce786a8f-46a7-4442-b4ab-f2e2f1d9858a" [Y] Yes [N] No (default is "N"):y Company ce786a8f-46a7-4442-b4ab-f2e2f1d9858a successfully deleted
~~Remove company with confirmation prompt.~~

Example 2: Remove company with confirmation prompt.

PS C:\> Remove-MBSAPICompany -id ce786a8f-46a7-4442-b4ab-f2e2f1d9858a -ProfileName MyProfile

Parameters

-ID

Company Id


Type	String
Required:	false
Position:	1
Default value:
Accept pipeline input:	true (ByValue, ByPropertyName)
Accept wildcard characters:	false

-Force

Force delete. Confirmation is disabled.


Type	SwitchParameter
Required:	false
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

-ProfileName

Profile name used with MSP360 PowerShell for MBS API (set via Set-MBSApiCredential)


Type	String
Required:	false
Position:	2
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-WhatIf


Type	SwitchParameter
Required:	false
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-Confirm


Type	SwitchParameter
Required:	false
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

System.Management.Automation.PSCustomObject String

Outputs

System.Management.Automation.PSCustomObject

Notes

Author: MSP360 Onboarding Team

Title: New-MBSNBFPlanSchedule HeadTitle: New-MBSNBFPlanSchedule Meta: 'New-MBSNBFPlanSchedule' RedirectUrl: ''

New-MBSNBFPlanSchedule

Returs MBS.Agent.Plan.NBFFullSchedule or MBS.Agent.Plan.NBFIncrementalSchedule object.


New-MBSNBFPlanSchedule
		-Incremental
		[-Monthly]
		-At <DateTime>
		[-Weekly]
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		-WeekNumber {First | Second | Third | Fourth | Penultimate | Last}
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		-OccursFrom <TimeSpan>
		-OccursTo <TimeSpan>
		-OccursEvery <TimeSpan>
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Monthly]
		[-Weekly]
		-At <DateTime>
		-DayOfMonth <Int32>
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Weekly]
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		-OccursFrom <TimeSpan>
		-OccursTo <TimeSpan>
		-OccursEvery <TimeSpan>
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[-Monthly]
		-At <DateTime>
		-DayOfMonth <Int32>
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Weekly]
		[-Monthly]
		-At <DateTime>
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		-WeekNumber {First | Second | Third | Fourth | Penultimate | Last}
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Daily]
		-OccursFrom <TimeSpan>
		-OccursTo <TimeSpan>
		-OccursEvery <TimeSpan>
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Daily]
		-At <DateTime>
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Incremental
		[-Once]
		-At <DateTime>
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Full
		[-Monthly]
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		-WeekNumber {First | Second | Third | Fourth | Penultimate | Last}
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Full
		[-Monthly]
		-DayOfMonth <Int32>
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Full
		[-Weekly]
		-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

New-MBSNBFPlanSchedule
		-Full
		[-Daily]
		[-RepeatInterval <Int32>]
		[-RepeatStartDate <DateTime>]
		[<CommonParameters>]

Description

Creates MBS backup plan schedule object.

Examples

Example 1: Run incremental (or first full) backup once at 10:00.

PS C:\> New-MBSNBFPlanSchedule -Incremental -Once -At 10:00

Example 2: Run daily incremental backup at 10:00.

PS C:\> New-MBSNBFPlanSchedule -Incremental -Daily -At 10:00

Example 3: Run incremental backup every Friday at 6 PM.

PS C:\> New-MBSNBFPlanSchedule -Incremental -Weekly -At "06:00 PM" -DayOfWeek Friday

Example 4: Run incremental backup every month on the third day at 6 PM.

PS C:\> New-MBSNBFPlanSchedule -Incremental -Monthly -At "18:00" -DayOfMonth 3

Example 5: Run full backup daily.

PS C:\> New-MBSNBFPlanSchedule -Full -Daily

Example 6: Run full backup every Friday.

PS C:\> New-MBSNBFPlanSchedule -Full -Weekly -DayOfWeek Friday

Example 7: Run full backup every month on the third day.

PS C:\> New-MBSNBFPlanSchedule -Full -Monthly -DayOfMonth 3

Parameters

-Incremental

[Parameter(Mandatory=$true, HelpMessage="Use to configure incremental backup schedule", ParameterSetName='Once')]


Type	SwitchParameter
Required:	true
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

-Full


Type	SwitchParameter
Required:	true
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

~~-Once~~

~~Run once~~

Type SwitchParameter

Required: false

Position: named

Default value: False

Accept pipeline input: false

Accept wildcard characters: false

-Daily

Run either daily at specific time or daily from/till specific time every specific min/hour


Type	SwitchParameter
Required:	false
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

-Weekly

Run weekly at specific time or weekly from/till specific time every specific min/hour


Type	SwitchParameter
Required:	false
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

-Monthly

Run monthly at specific time or monthly from/till specific time every specific min/hour


Type	SwitchParameter
Required:	false
Position:	named
Default value:	False
Accept pipeline input:	false
Accept wildcard characters:	false

-At

Specify either datetime or time of schedule


Type	DateTime
Required:	true
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-DayOfMonth

Specify day for 'dayofmonth' schedule (1..31)


Type	Int32
Required:	true
Position:	named
Default value:	0
Accept pipeline input:	false
Accept wildcard characters:	false

-DayOfWeek

Specify day(s) of week for weekly schedule or day of week for monthly schedule. Possible values: First, Second, Third, Fourth, Penultimate, Last


Type	DayOfWeek[]
Required:	true
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-WeekNumber

Specify number of week. Possible values: First, Second, Third, Fourth, Penultimate, Last


Type	WeekNumber
Required:	true
Position:	named
Accepted values:	First, Second, Third, Fourth, Penultimate, Last
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-OccursFrom

Specify daily recurring from value


Type	TimeSpan
Required:	true
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-OccursTo

Specify daily recurring till value


Type	TimeSpan
Required:	true
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-OccursEvery

Specify recurring period value. Possible values: 1-59 min, or 1-180 hour

Type TimeSpan

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false


Type	TimeSpan
Required:	true
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

-RepeatInterval

Specify repeat period value (days). Possible values: 1..31


Type	Int32
Required:	false
Position:	named
Default value:	0
Accept pipeline input:	false
Accept wildcard characters:	false

-RepeatStartDate

Specify start date of repetitions


Type	DateTime
Required:	false
Position:	named
Default value:
Accept pipeline input:	false
Accept wildcard characters:	false

CommonParameters

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

Inputs

None.

Outputs

MBS.Agent.Plan.NBFIncrementalSchedule MBS.Agent.Plan.NBFFullSchedule

Notes

Author: MSP360 Onboarding Team

Title: Restart-MBSAgentService HeadTitle: Restart-MBSAgentService Meta: 'Restart-MBSAgentService' RedirectUrl: ''

Restart-MBSAgentService

Restart MBS Agent services


Restart-MBSAgentService
		[<CommonParameters>]

Description

Restart Online Backup Service and Online Backup Remote Management Service regardless of their actual names, which can be different because of branding settings.

Examples

Example 1: Restarts the MBS Agent backup and remote management services.

PS C:\> Restart-MBSAgentService

Parameters

CommonParameters

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

Inputs

None

Outputs

None

Notes

Author: MSP360 Onboarding Team

Title: Start-MBSAgentService HeadTitle: Start-MBSAgentService Meta: 'Start-MBSAgentService' RedirectUrl: ''

Start-MBSAgentService

Start MBS Agent services


Start-MBSAgentService
		[<CommonParameters>]

Description

Start Online Backup Service and Online Backup Remote Management Service regardless of their actual names, which can be different because of branding settings.

Examples

Example 1: Starts the MBS Agent backup and remote management services.

PS C:\> Start-MBSAgentService

Parameters

CommonParameters

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

Inputs

None

Outputs

None

Notes

Author: MSP360 Onboarding Team

File tree

28 files changed

28 files changed

Title: Edit-MBSAPIAdministrator HeadTitle: Edit-MBSAPIAdministrator Meta: 'Edit-MBSAPIAdministrator' RedirectUrl: ''

Edit-MBSAPIAdministrator

Description

Examples

Example 1:

Example 2: Note: If the administrator initially has access to all companies and you want to assign specific companies to him, parameter '-AccessToCompaniesMode SpecifiedCompanies' is needed to be explicitly specified.

Parameters

Inputs

Outputs

Notes

Title: Edit-MBSAPICompany HeadTitle: Edit-MBSAPICompany Meta: 'Edit-MBSAPICompany' RedirectUrl: ''

Edit-MBSAPICompany

Description

Examples

Example 1:

Example 1: Change the name, storage limit, and license setting for company with ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce

Example 2: Change (overwrite) the destinations of a company with ID 27fbcbb0-cb0b-40e5-8c4a-bd7faf18ffce

Parameters

Inputs

Outputs

Notes

Title: Edit-MBSAPIUserBackupDestination HeadTitle: Edit-MBSAPIUserBackupDestination Meta: 'Edit-MBSAPIUserBackupDestination' RedirectUrl: ''

Edit-MBSAPIUserBackupDestination

Description

Examples

Example 1: PS C:> $Destionation1 = (Get-MBSAPIUserBackupDestination -profilename ao -useremail [email protected])[0]

Parameters

Inputs

Outputs

Notes

Title: New-MBSAPIAdministrator HeadTitle: New-MBSAPIAdministrator Meta: 'New-MBSAPIAdministrator' RedirectUrl: ''

New-MBSAPIAdministrator

Description

Examples

Example 1:

Parameters

Inputs

Outputs

Notes

Title: New-MBSAPIAdministratorPermission HeadTitle: New-MBSAPIAdministratorPermission Meta: 'New-MBSAPIAdministratorPermission' RedirectUrl: ''

New-MBSAPIAdministratorPermission

Description

Examples

Example 1: Create object with administrator permissions that allow only to manage notifications, remote management, downloads, and backup history.

Example 2: Create object with administrator permissions that enables all permissions except managing administrators and all actions related to licenses.

Example 3: Create object with administrator permissions that enables all permissions

Parameters

Inputs

Outputs

Notes

Title: New-MBSAPICompany HeadTitle: New-MBSAPICompany Meta: 'New-MBSAPICompany' RedirectUrl: ''

New-MBSAPICompany

Description

Examples

Example 1: Create company named Contoso with unlimited storage and Global licensing pool.

Example 2: Create company named ComputerCompany with 1 Tb storage limit, Custom licensing pool and backup destinations that have display names containing "AWS" and "Local"

Parameters

Inputs

Outputs

Notes

Title: Remove-MBSAPICompany HeadTitle: Remove-MBSAPICompany Meta: 'Remove-MBSAPICompany' RedirectUrl: ''

Remove-MBSAPICompany

Description

Examples

Example 1: Company ce786a8f-46a7-4442-b4ab-f2e2f1d9858a successfully deleted

Example 1: Remove company by ID in force mode (no confirmation)

Example 2: Are you sure you want to perform this action?

Example 2: Remove company with confirmation prompt.

Parameters

Inputs

Outputs

Notes

Title: New-MBSNBFPlanSchedule HeadTitle: New-MBSNBFPlanSchedule Meta: 'New-MBSNBFPlanSchedule' RedirectUrl: ''

New-MBSNBFPlanSchedule

Description

Examples

Example 1: Run incremental (or first full) backup once at 10:00.