Post on 16-Apr-2020
IBM System Storage N series
SnapManager 8.0 for Microsoft SharePointSDK Management Shell User’s Guide
SC27-5428-01
���
Contents
Preface .......................................................................................................................................................... 4
Supported Features .................................................................................................................................. 4
Websites ................................................................................................................................................... 4
Getting Information, Help, and Service .................................................................................................... 5
Before You Call.......................................................................................................................................... 5
Using the Documentation ......................................................................................................................... 5
Hardware Service and Support ................................................................................................................. 5
Firmware Updates..................................................................................................................................... 6
How to Send Your Comments................................................................................................................... 6
Overview ....................................................................................................................................................... 7
SnapManager CLI .......................................................................................................................................... 9
Before You Begin........................................................................................................................................... 9
Configuration ............................................................................................................................................ 9
Agents ....................................................................................................................................................... 9
Getting Started............................................................................................................................................10
Environment Requirements....................................................................................................................10
SnapManager for SharePoint SDK ..............................................................................................................11
Supported Features in SnapManager 8 for SharePoint SDK...................................................................11
SnapManager for SharePoint Management Shell ......................................................................................14
Installing the Management Shell ............................................................................................................14
Accessing SnapManager for SharePoint Management Shell ..................................................................15
Upgrading SnapManager for SharePoint SDK and Management Shell ..................................................17
SnapManager for SharePoint Management Shell Cmdlet Reference ........................................................19
Log into SMSP Manager ..........................................................................................................................19
Log Out of SMSP Manager ......................................................................................................................20
Control Panel...........................................................................................................................................20
Storage Optimization ..............................................................................................................................40
2 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Data Protection.......................................................................................................................................51
Job Monitor.............................................................................................................................................52
Copyright and trademark information....................................................................................................................55
Trademark Information...............................................................................................................................56
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 3 Shell User’s Guide
Preface
Supported Features
IBM System Storage N series storage systems are driven by NetApp Data ONTAP software. Some
features described in the product software documentation are neither offered nor supported by IBM.
Please contact your local IBM representative or reseller for further details.
Information about supported features can also be found on the N series support Website (accessed and
navigated as described in Websites).
Websites
IBM maintains pages on the World Wide Web where you can get the latest technical information and
download device drivers and updates. The following Web pages provide N series information:
A listing of currently available N series products and features can be found at the following Web page:
www.ibm.com/storage/nas/
The IBM System Storage N series support Website requires users to register in order to obtain access to N series support content on the Web. To understand how the N series support Web content is organized and navigated, and to access the N series support Website, refer to the following publicly accessible Web page:
www.ibm.com/storage/support/nseries/
This Web page also provides links to AutoSupport information as well as other
important N series product resources.
IBM System Storage N series products attach to a variety of servers and operating systems. To determine the latest supported attachments, go to the IBM N series interoperability matrix at the following Web page:
www.ibm.com/systems/storage/network/interophome.html
For the latest N series hardware product documentation, including planning, installation and setup, and hardware monitoring, service and diagnostics, see the IBM N series Information Center at the following Web page:
publib.boulder.ibm.com/infocenter/nasinfo/nseries/index.jsp
4 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Getting Information, Help, and Service
If you need help, service, or technical assistance or just want more information about IBM products, you
will find a wide variety of sources available from IBM to assist you. This section contains information
about where to go for additional information about IBM and IBM products, what to do if you experience
a problem with your IBM N series product, and whom to call for service, if it is necessary.
Before You Call
Before you call, make sure you have taken these steps to try to solve the problem yourself:
Check all cables to make sure they are connected.
Check the power switches to make sure the system is turned on.
Use the troubleshooting information in your system documentation and use the diagnostic tools that come with your system.
Refer to the N series support Website (accessed and navigated as described in Websites) for information on known problems and limitations.
Using the Documentation
The latest versions of N series software documentation, including Data ONTAP and other software
products, are available on the N series support Website (accessed and navigated as described in
Websites).
Current N series hardware product documentation is shipped with your hardware product in printed
documents or as PDF files on a documentation CD. For the latest N series hardware product
documentation PDFs, go to the N series support Website.
Hardware documentation, including planning, installation and setup, and hardware monitoring, service,
and diagnostics, is also provided in an IBM N series Information Center at the following Web page:
publib.boulder.ibm.com/infocenter/nasinfo/nseries/index.jsp
Hardware Service and Support
You can receive hardware service through IBM Integrated Technology Services. Visit the following Web
page for support telephone numbers:
www.ibm.com/planetwide/
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 5 Shell User’s Guide
Firmware Updates
IBM N series product firmware is embedded in Data ONTAP. As with all devices, ensure that you run the
latest level of firmware. Any firmware updates are posted to the N series support Website (accessed and
navigated as described in Websites).
*Note: If you do not see new firmware updates on the N series support Website, you are running the
latest level of firmware.
Verify that the latest level of firmware is installed on your machine before contacting IBM for technical
support.
How to Send Your Comments
Your feedback helps us to provide the most accurate and high‐quality information. If you have
comments or suggestions for improving this document, please send them by e‐mail to
starpubs@us.ibm.com.
Be sure to include the following:
Exact publication title
Publication form number (for example, GC26‐1234‐02)
Page, table, or illustration numbers
A detailed description of any information that should be changed
6 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Overview
SnapManager for SharePoint is an enterprise‐strength backup, recovery, and data management solution
for SharePoint Foundation 2010 and SharePoint Server 2010 (all current and future service packs), as
well as SharePoint Foundation 2013 and SharePoint Server 2013.
Operating on IBM’s latest distributed software platform, SnapManager for SharePoint is accessible from
anywhere in the network through Internet Explorer® (other browsers are supported), and can monitor
multiple SharePoint environments across a network. SnapManager for SharePoint Manager’s main
features include the following:
The ability to centrally manage SharePoint backup and recovery jobs including scheduling, monitoring, reporting (logging and e‐mail notifications), user account management, and software Agent management across multiple SharePoint farms from a single accessible‐from‐anywhere Web interface
Fast backup speeds leveraging N series Snapshot backups, as well as real‐ time granular restore of items, item versions, lists, libraries, sites, and site collections directly onto the production server or an alternate location
Backup coverage of all SharePoint 2010 and 2013 databases
Backup of SharePoint search index files
Backup of various SharePoint component settings including SharePoint and third‐party solutions, IIS settings on Web front‐end servers, SharePoint Global Search settings, and InfoPath Forms Services
SnapMirror replication for backups of SharePoint databases and search indexes, Storage Manager BLOB data and Connector BLOB data, and verification of SnapMirror destination targets
SnapVault data set backup for backups of: SharePoint databases and search indexes, Storage Manager BLOB data and Connector BLOB data, and verification of SnapVault targets
Configure multiple schedules for different restore granularity levels in a single backup plan
Separately schedule verification jobs apart from backup or restore jobs
Separately schedule granular indexing jobs apart from backup jobs
Ability to browse and restore individual items from backup directly without generating an index at backup time
Different retention settings for the same backup components in multiple plans
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 7 Shell User’s Guide
Extend contents from the primary SQL content database storage to more affordable file system based locations (for example, CIFS devices) leveraging RBS
Archiving and end‐user‐initiated archiving can delete historical contents (from items to site collections), or move them based on fully customizable business rules or an on‐demand basis with tiered storage management and the support of backup and recovery
Connector can attach any N series CIFS Share to SharePoint, taking advantage of all SharePoint content management and presentation features without any ingestion of content into the SharePoint content database
Integration with N series SnapLock technology
Integration with N series ASUP system for streamlined support
Integration with SCOM (Microsoft System Center Operations Manager) event log
Support to backup and restore FAST Search Server Farms
In addition, SnapManager for SharePoint offers the option to evaluate various DocAve products for 90
days, including Migration, Granular Backup and Restore, Administration, Compliance products, and
Report Center.
8 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
SnapManager CLI
The APIs provided in the SnapManager for SharePoint SDK can be used to write your own commands
and scripts. The SnapManager for SharePoint Management Shell provides you with many pre‐defined
commands that enable you to perform SMSP functions.
Discuss differences between SnapManager for SharePoint SDK and SnapManager for SharePoint
Management Shell.
Before You Begin
Refer to the sections below for system and farm requirements that must be in place prior to installing
and using SnapManager for SharePoint Software Development Kit (SDK) and Management Shell.
Configuration
In order to use SnapManager for SharePoint SDK and Management Shell, the SnapManager for
SharePoint platform must be installed and configured properly on your farm. SnapManager for
SharePoint SDK and Management Shell will not function without SnapManager for SharePoint.
Agents
SnapManager for SharePoint Agents are responsible for running SnapManager for SharePoint jobs and
interacting with the SharePoint object model. For more information on SnapManager for SharePoint
Agents, refer to the SnapManager for SharePoint Installation Guide.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 9 Shell User’s Guide
Getting Started
Refer to the sections below for important information on getting started with SDK and Management
Shell.
Environment Requirements
For SnapManager for SharePoint SDK, the .NET Framework version must be v3.5 SP1 or later.
For SnapManager for SharePoint Management Shell, the .NET Framework version must be 3.5 SP1 or
later and the PowerShell version must be v2.0 or later.
10 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
SnapManager for SharePoint SDK
Build customizable, extendable, and programmable usage of SnapManager for SharePoint functions by
invoking the program interfaces provided by SnapManager for SharePoint SDK.
To access detailed information on the commands available in the SnapManager for SharePoint SDK:
1. On a server that has SnapManager for SharePoint Manager or Agent installed on it, go to Start > All Programs > SnapManager 8 for SharePoint > SMSP SDK.
2. Double‐click the help file named SMSP SDK Documentation to view detailed information on the commands. You can also find the help file in the following path: \IBM\SMSP8\Shell\DocAveModules\DocAveModule\DocAveSDK.chm.
Supported Features in SnapManager 8 for SharePoint SDK
The table below lists the supported features in SMSP 8 SDK.
Module Supported Features
SMSP Manager Log into SMSP Manager
Log out of SMSP Manager
Account Manager Add a local user
Update the settings of an existing local system user
Delete a local system user
Add an active directory user
Update the settings of an existing active directory user
Delete an active directory user
Get all of the existing local users
Get all of the active directory users/groups
Agent Monitor Get all of the Agent services
Update the Agent service’s credentials
Physical Device Get a blank physical device
Get all of the existing physical devices
Create a new physical device
Update the settings of an existing physical device
Delete a physical device
Logical Device Get a blank logical device
Get all of the existing logical devices
Create a new logical device
Update the settings of an existing logical device
Delete a logical device
Storage Policy Get a blank storage policy
Get all of the existing storage policies
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 11 Shell User’s Guide
Module Supported Features
Create a new storage policy
Update the settings of an existing storage policy
Delete a storage policy
Archive Manager Get all of the existing Archive Manager rules
Get the rules that have been applied rules on a SharePoint object
Reuse an existing rule on a SharePoint object
Apply an existing rule on a SharePoint object
Check and change a SharePoint object’s inheriting status
Get all of the existing Archive Manager profiles
Get the profiles that have been applied rules on a SharePoint object
Apply a profile on a SharePoint object
Retract an already applied profile
Run an Archive Manager job
Storage Optimization BLOB Provider Settings
Get the configurations of a stub database
Configure the stub database settings
Get the RBS settings
Configure the RBS settings
Get the EBS settings
Configure the EBS settings
Real‐time Storage Manager Create a real‐time storage manager rule
Update the settings of an existing real‐time storage manager rule
Delete an existing real‐time storage manager rule
Get all of the real‐time storage manager rule
Reuse a real‐time storage manager rule on a SharePoint object
Get the real‐time storage manager rules that have been applied on a SharePoint object
Retract a real‐time storage manager rule
Scheduled Storage Manager Get all of the existing storage manager profiles
Reuse a storage manager profile on a SharePoint site collection
Retract a storage manager profile from a SharePoint site collection
Update Manager Get all of the available update
Upload an update
Test an update
Install an update
Storage Configuration Get all of the existing physical devices
Create a physical device of the CIFS Share type
Get all of the existing logical devices
Platform Backup and Restore Run a plan
12 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Module Supported Features
Get the default settings of a backup plan
Job Monitor Get the desired jobs
Get the summary information of a job
Get the detailed information of a job
Download the report of a job
*Note: SMSP command lines and APIs work on the SharePoint folder level and SharePoint item level in
SnapManager 8 for SharePoint.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 13 Shell User’s Guide
SnapManager for SharePoint Management Shell
SnapManager for SharePoint provides a command line management interface based on Windows
PowerShell. You can perform the SnapManager for SharePoint operations using the provided cmdlet.
Installing the Management Shell
By default, SnapManager for SharePoint Management Shell is installed together with SnapManager for
SharePoint Manager/Agent. You can find it in Start > All Programs > SnapManager 8 for SharePoint >
SMSP Management Shell.
You can also install a SnapManager for SharePoint Management Shell server that does not have a
SnapManager for SharePoint Manager/Agent installed on it. To install SnapManager for SharePoint
Management Shell separately, see the following steps:
1. Copy the folder named Shell in the SnapManager for SharePoint installation path (…\IBM\SMSP8).
2. Paste this folder into the server where you want to install SnapManager for SharePoint Management Shell. This folder can reside anywhere within the server’s directory.
3. Right‐click ShellInstallation.exe under …\Shell\Setup and select Run as administrator.
4. Specify a local installation path or press Enter to use the default location, which is C:\Program Files\IBM.
Figure 1: Specify the installation location.
14 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
5. Press any key to exit when the installation completes.
Figure 2: Exit the tool.
Accessing SnapManager for SharePoint Management Shell
After installing SnapManager 8 for SharePoint Management Shell, use either of the following two
methods to access it.
Go to Start > All Programs > SnapManager 8 for SharePoint > SMSP Management Shell and click SMSP Management Shell to open the interface.
Use Windows PowerShell. Click the Windows PowerShell icon on the left of Windows taskbar to open it. Then, import the SnapManager for SharePoint PowerShell module by executing the command: Import‐Module ‐Name DAModule ‐DisableNameChecking
*Note: Before using any SnapManager for SharePoint cmdlets, you must log into SnapManager for
SharePoint using Login‐DAManager cmdlet first. You can obtain additional information on using this
cmdlet by entering Get‐Help Login‐DAManager.
To get the overview of all of the commands available for SnapManager for SharePoint, execute the
command:
Get‐Command ‐Module DocAveModule
To search all of the commands related to a module, use a “fuzzy” query. For example, execute the
following command to retrieve all of the commands related to the Platform Backup modules:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 15 Shell User’s Guide
Get‐Command ‐Name *PlatformBackup*
16 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Upgrading SnapManager for SharePoint SDK and Management
Shell
To ensure proper functionality, the SnapManager for SharePoint SDK and Management Shell must be
the same version as the SnapManager for SharePoint platform. The information below details where to
find instructions on updating the SnapManager for SharePoint SDK and Management Shell to a version
>7.0.
For detailed steps regarding how to upgrade the SnapManager for SharePoint SDK, refer to SMSP SDK
Documentation, which is available in the following path by
default: …\IBM\SMSP8\Shell\DocAveModules\DocAveModule\DocAveSDK.chm.
For detailed steps regarding how to upgrade the SnapManager for SharePoint Management Shell, refer
to the conceptual topic Get‐Help about _DAUpdate cmdlet in the SnapManager 8 for SharePoint
Management Shell:
1. Open the SMSP Management Shell.
2. Enter Get‐Help about_DAUpdate, and then press Enter.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 17 Shell User’s Guide
Figure 3: Get-Help about_DAUpdate in SMSP Management Shell
18 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
SnapManager for SharePoint Management Shell Cmdlet
Reference
SnapManager for SharePoint Management Shell provides a rich set of commands based on the
SnapManager platform. These commands allow you to perform various operations including run a plan,
delete a plan, etc. The section below lists all of the existing SnapManager for SharePoint Management
Shell cmdlets, a corresponding example of each cmdlet, as well as the descriptions of the parameters in
each cmdlet.
*Note: SMSP 8 SDK provides a Connector API welcome page to allow users to get the functional
summary of Connector API, and provides the directory of the Connector SDK in SMSP Agent server.
Log into SMSP Manager
*Note: The Login‐DAManager cmdlet only supports the local user to log in to SMSP.
To log into SnapManager for SharePoint manager, run the following command:
Login‐DAManager ‐ControlHost <String> ‐ControlPort <Int32> ‐Credential <PSCredential>
[<CommonParameters>]
The examples of the command are:
C:\PS>$Credential = Get‐Credential
C:\PS>Login‐DAManager ‐ControlHost localhost ‐ControlPort 14000 ‐Credential $credential
Or
C:\PS>$SecurePassword = Read‐Host –AsSecureString
C:\PS>Login‐DAManager ‐ControlHost localhost ‐ControlPort 14000 ‐Username admin ‐Password
$SecurePassword
Or
C:\PS>Login‐DAManager ‐ControlHost localhost ‐ControlPort 14000 ‐Username admin ‐
PlainTextPassWord admin
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐ControlHost Required Specifies the address of control host.
‐ControlPort Required Specifies the control port.
‐Credential Required Specifies the credential.
‐Username Required Specifies the username.
‐Password Required Specifies the password in the form of secure
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 19 Shell User’s Guide
Parameter Type Comment
string.
‐PlainTextPassword Required Specifies the password in the form of plain text string.
Log Out of SMSP Manager
To log out of SMSP Manager, run the command below:
Logout‐DAManager [<CommonParameters>]
An example of the command is:
C:\PS>Logout‐DAManager
Control Panel
Refer to the section below for more information on the cmdlets’ usage in Control Panel.
Obtain a Date Object
To obtain a date object used for defining a specific date in a scheduled plan, run the command below:
Get‐DADate [‐Year] <Int32> [‐Month] <Int32> [‐Day] <Int32> [‐TimeZoneId] <SupportedTimeZoneId>
[<CommonParameters>]
An example of the command is:
C:\PS>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime
C:\PS>Get‐DADate ‐Year 2012 ‐Month 03 ‐Day 20 ‐TimeZoneId
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Year Required Specifies the year that is displayed. Valid value is between 1 and 9999.
‐Month Required Specifies the month that is displayed. Valid value is between 1 and 12.
‐Day Required Specifies the day that is displayed. Valid value is between 1 and 31.
‐TimeZoneId Required Specifies the time zone ID.
Obtain a Time Object
To get a time object used for defining a specific time in a scheduled plan, run the command below:
20 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Get‐DADateTime [‐Year] <Int32> [‐Month] <Int32> [‐Day] <Int32> [‐Hour] <Int32> [‐Minute] <Int32> [‐
TimeZoneId] <SupportedTimeZoneId> [<CommonParameters>]
The example of the command is:
C:\PS>$TimeZoneID = [DocAve.API.Common.SupportedTimeZoneId]::PacificSAStandardTime
C:\PS>Get‐DADateTime ‐Year 2012 ‐Month 03 ‐Day 20 ‐Hour 14 ‐Minute 30 ‐TimeZoneId $TimeZoneID
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Year Required Specifies the year that is displayed. Valid value is between 1 and 9999.
‐Month Required Specifies the month that is displayed. Valid value is between 1 and 12.
‐Day Required Specifies the day that is displayed. Valid value is between 1 and 31.
‐Hour Required Specifies the hour that is displayed. Valid value is between 0 and 23.
‐Minute Required Specifies the minute that is displayed. Valid value is between 0 and 59.
‐TimeZoneId Required Specifies the time zone ID.
Agent Monitor
Refer to the section below for more information on getting and updating Agent service.
Get SMSP Agent Service
To get the Agent service of SnapManager for SharePoint, run the command below:
Get‐DAAgentService [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAAgentService
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐Name Optional Specifies the names of the existing Agent services you want to get. Wildcards and multiple values are allowed, which are separated by commas. If no values are entered here, all of the existing Agent services will be obtained.
Update SMSP Agent Service
To update the Agent service of SnapManager for SharePoint, run the command below:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 21 Shell User’s Guide
Update‐DAAgentService [‐AgentService] <AgentService> [<CommonParameters>]
An example of the command is:
C:\PS>$agent = Get‐DAAgentService ‐Name 'agent1'
C:\PS>$pwd = Read‐Host –AsSecureString
*****
C:\PS>$agent.SetAccount('mydomain\user1', $pwd)
C:\PS>Update‐DAAgentService ‐AgentService $agent
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐AgentService Required Specifies an Agent service for updating.
Account Manager
Refer to the section below for more information on the cmdlets’ usage in Account Manager.
Get the Information of an Active Directory Group
To get the information of a specified active directory group, run the command below:
Get‐DAActiveDirectoryGroup [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>$user = Get‐DAActiveDirectoryGroup C:\PS>$user Name: example.com\group1
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies the names of the active directory groups you want to obtain. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all existing active directory groups will be obtained.
Get the Information of an Active Directory
To get the information of an active directory user, run the command below:
Get‐DAActiveDirectoryUser [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>$user = Get‐DAActiveDirectoryUser
C:\PS>$user Name: example.com\user1
22 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies the names of the active directory users you want to obtain. Wildcards and multiple values are supported, which are separated by commas. If no values are entered, all existing active directory users will be obtained.
Get the Information of a Local User
To get the information of a local user, run the command below:
Get‐DALocalUser [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DALocalUser ‐Name: user1
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies the names of the local users you want to obtain. Wildcards and multiple values are supported, which should be separated by commas. If no values are entered, all existing local users will be obtained.
Get the Blank Active Directory Group
To get the blank active directory group, run the command below:
Get‐DABlankActiveDirectoryGroup [<CommonParameters>]
An example of the command is:
C:\PS>$user = Get‐DABlankActiveDirectoryGroup
C:\PS>$user
Get a Blank Active Directory User
To get the blank active directory user, run the command below:
Get‐DABlankActiveDirectoryUser [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DABlankActiveDirectoryUser
Get a Blank Local User
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 23 Shell User’s Guide
To get a blank local user, run the command below:
Get‐DABlankLocalUser [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DABlankLocalUser
Create a New User
To create a new user, run the command below:
New‐DAUser [‐User] <UserBase> [<CommonParameters>]
The examples of the command are:
C:\PS>$user = Get‐DABlankLocalUser
C:\PS>$user.Name = 'user1'
C:\PS>$user.Email = 'user1@example.com'
C:\PS>$user.Password = Read‐Host ‐AsSecureString
*********
C:\PS>$user.Description = 'This is a Local User'
C:\PS>
C:\PS>$groups = New‐Object System.Collections.Generic.List[string]
C:\PS>$groups.Add('system group 01')
C:\PS>$user.SetSystemGroups($groups)
C:\PS>
C:\PS>$user.SetSecuritySettingsType('Customized')
C:\PS>$user.SecuritySettings.AccountIsInactive = $false
C:\PS>$user.SecuritySettings.UserMustChangePasswordAtNextLogon = $true
C:\PS>New‐DAUser –User $user
Or
C:\PS>$user = Get‐DABlankActiveDirectoryUser
C:\PS>$user.Name = 'example.com\user1
C:\PS>$user.SetTenantGroup('tenant group 01')
C:\PS>New‐DAUser –User $user
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐User Required Specifies a user object to create a new user. For more information about the structure and attributes of user, please refer to the SMSP SDK Documentation for more information.
24 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Delete an Active Directory Group
To delete an active directory group, run the command below:
Remove‐DAActiveDirectoryGroup [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
C:\PS>Remove‐DAActiveDirectoryGroup ‐Name 'example.com\group1'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Required Specifies the name of an active directory group that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command without actually executing the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Delete an Active Directory User
To delete an active directory user, run the command below:
Remove‐DAActiveDirectoryUser [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
C:\PS>Remove‐DAActiveDirectoryUser ‐Name 'example.com\user1'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Required Specifies the name of an active directory user that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Delete a Local User
To delete a local user, run the command below:
Remove‐DALocalUser [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 25 Shell User’s Guide
C:\PS>Remove‐DALocalUser ‐Name 'user1'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Required Specifies the name of a local user that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Update the User Information
To update the information of an existing user, run the command below:
Update‐DAUser [‐User] <UserBase> [<CommonParameters>]
An example of the command is:
C:\PS>$user = Get‐DALocalUser ‐Name 'user1'
C:\PS>$user.Email = 'user1@example.com'
C:\PS>Update‐DAUser $user
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐User Required Specifies a user object where you want to edit the user.
Security Information Manager
Refer to the section below for more information on the cmdlets’ usage in Security Profile Manager.
Back Up the Data Encryption Profile
To back up the data encryption profile, run the command below:
Backup‐DADataEncryptionProfile [‐Path] <String> [‐Overwrite] [<CommonParameters>]
*Note: Data encryption profile is renamed to security profile since SMSP 7.0.
An example of the command is:
C:\PS>Backup‐DADataEncryptionProfile ‐Path 'C:\backup.zip'
To configure the command parameters, refer to the table below.
26 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Parameter Type Comment
‐Path Required Specifies a path to store the backup file.
‐Overwrite Optional Overwrites the backup file if it already exists in the specified path.
Back Up a Database Encryption Key
To back up a database encryption key, run the command below:
Backup‐DADatabaseEncryptionKey [‐Path] <String> [‐Overwrite] [<CommonParameters>]
An example of the command is:
C:\PS>Backup‐DADatabaseEncryptionKey ‐Path 'C:\backup.zip'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Path Required Specifies a path to store the backup file.
‐Overwrite Optional Overwrites the backup file if it already exists in the specified path.
Restore a Database Encryption Key
To restore a database encryption key, run the command below:
Restore‐DADatabaseEncryptionKey [‐Path] <String> [‐OutPut] <String> [‐Overwrite] [[‐Passphrase]
<String>] [<CommonParameters>]
The examples of the command are:
C:\PS>Restore‐DADatabaseEncryptionKey ‐Path 'C:\backup' ‐OutPut 'C:\sql'
C:\PS>Restore‐DADatabaseEncryptionKey ‐Path 'C:\backup' ‐OutPut 'C:\sql' ‐Passphrase passphrase
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Path Required Specifies a path to load the backup file.
‐OutPut Required Specifies a path to store the output file.
‐Overwrite Optional Overwrites the output file if it already exists in the specified path.
‐Passphrase Optional Specifies a passphrase value to encrypt SnapManager for SharePoint database encryption key. If this parameter is not used, the cmdlet will read the passphrase from the local machine. Ensure that the passphrases are matched between the local machine and the SnapManager for SharePoint database; otherwise, the SnapManager for SharePoint system will not work.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 27 Shell User’s Guide
Restore a Data Encryption Profile
To restore a data encryption profile, run the command below:
Restore‐DADataEncryptionProfile [‐Path] <String> [<CommonParameters>]
*Note: Data encryption profile is renamed to security profile since SMSP 7.0.
An example of the command:
C:\PS>Backup‐DADataEncryptionProfile ‐Path 'C:\backup.zip'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Path Required Specifies a path to load the backup file.
Set Up the Status of a FIPS Algorithm Policy
To set up the status of a specified FIPS Algorithm Policy, run the command below:
Set‐DAFipsAlgorithmPolicy [[‐Disabled]] [<CommonParameters>]
Set‐DAFipsAlgorithmPolicy [[‐Enabled]] [<CommonParameters>]
The examples of the command are:
C:\PS>Set‐DAFipsAlgorithmPolicy ‐Enabled
C:\PS>Set‐DAFipsAlgorithmPolicy ‐Disabled
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Disabled Optional Disables the FIPS Algorithm Policy.
‐Enabled Optional Enables the FIPS Algorithm Policy.
Set Up the Passphrase
To set up a new value for the passphrase, run the command below:
Set‐DAPassPhrase [‐PassPhrase] <SecureString> [‐ConfirmPassPhrase] <SecureString>
[<CommonParameters>]
Set‐DAPassPhrase [‐PassPhrase] <SecureString> [‐LocalServerOnly] [<CommonParameters>]
28 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
The examples of the command are:
C:\PS>$passphrase = ConvertTo‐SecureString 'PassPhrase' ‐AsPlainText ‐Force
C:\PS>$ConfirmPassPhrase = ConvertTo‐SecureString 'PassPhrase' ‐AsPlainText ‐Force
C:\PS>Set‐DAPassPhrase ‐PassPhrase $passphrase ‐ConfirmPassPhrase $ConfirmPassPhrase
Or
C:\PS>$passphrase = ConvertTo‐SecureString 'PassPhrase' ‐AsPlainText ‐Force
C:\PS>Set‐DAPassPhrase ‐PassPhrase $passphrase ‐LocalServerOnly
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐PassPhrase Required Specifies a new passphrase value.
‐ConfirmPassPhrase Required Confirms the new passphrase value.
‐LocalServerOnly Optional This parameter will only change the passphrase of this local server. If this parameter is not used, the passphrase change will be performed on all the servers in the SnapManager for SharePoint system.
Physical Device
Get a Blank Physical Device for Creating a New Physical Device
To get a blank physical device, run the command below:
Get‐DABlankPhysicalDevice [‐Type] <String> [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DABlankPhysicalDevice ‐Type DataONTAPCIFSShare
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Type Required Specifies a storage type for the physical device. Valid values are "DataONTAPCIFSShare" and "NetShare".
Get the Configuration Details of a Physical Device
To get the configuration details of a physical device, run the command below:
Get‐DAPhysicalDevice [[‐Name] <String[]>] [<CommonParameters>]
Get‐DAPhysicalDevice [‐Type] <StorageType> [<CommonParameters>]
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 29 Shell User’s Guide
The examples of the command are:
C:\PS>Get‐DAPhysicalDevice ‐Name 'physical device1'
Or
C:\PS>Get‐DAPhysicalDevice
Or
C:\PS>Get‐DAPhysicalDevice ‐Type DataONTAPCIFSShare
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies one or more physical device names. Multiple physical device names must be separated by commas. Wildcards are supported. If you do not type a value, the information of all physical devices will be returned.
‐Type Required Specifies the physical device type. Valid values are “DataONTAPLUN” and “DataONTAPCIFSShare”.
Create a New Physical Device
To create a new physical device, run the command below:
New‐DAPhysicalDevice [‐PhysicalDevice] <PhysicalDeviceBase> [<CommonParameters>]
The examples of the command are:
C:\PS>$device = Get‐DABlankPhysicalDevice ‐Type DataONTAPCIFSShare
C:\PS>$device.Name = 'physical device1'
C:\PS>$device.StorageSystemProfile = 'storage system profile1'
C:\PS>$device.ShareName = 'sharename1'
C:\PS>$device.Username = 'example.com\user1'
C:\PS>$device.Password = Read‐Host –AsSecureString
**********
C:\PS>$device.SpaceThreshold = '1300MB'
C:\PS>$device.ExtendedParameters = 'SnapLockEnabled = True'
C:\PS>$device.Farms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')
C:\PS>New‐DAPhysicalDevice $device
C:\PS>
Or
30 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
C:\PS>$device = Get‐DABlankPhysicalDevice ‐Type NetShare
C:\PS>$device.Name = 'physical device1'
C:\PS>$device.Description = 'Description'
C:\PS>$device.SpaceThreshold = '1024MB'
C:\PS>$device.ExtendedParameters.Add("AuthMethod=NetUse")
C:\PS>$device.ExtendedParameters.Add("IsRetry=true")
C:\PS>$device.UNCPath = '\\admin‐PC\c$\data'
C:\PS>$device.Username = 'example.com\user1'
C:\PS>$device.Password = Read‐Host –AsSecureString
*********
C:\PS>New‐DAPhysicalDevice ‐PhysicalDevice $device
C:\PS>
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐PhysicalDevice Required Specifies a physical device object. About the structure and attributes of the physical device, refer to the SMSP SDK Documentation for more information.
Update a Physical Device
To update an existing physical device, run the following command line:
Update‐DAPhysicalDevice [‐PhysicalDevice] <PhysicalDeviceBase> [<CommonParameters>]
An example of the command is:
C:\PS>$device = Get‐DAPhysicalDevice ‐Name 'physical device1'
C:\PS>$device.Name = 'physical device2'
C:\PS>$device.Description = 'Description'
C:\PS>Update‐DAPhysicalDevice ‐PhysicalDevice $device
C:\PS>
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐PhysicalDevice Required Specifies an existing physical device object to be updated.
Delete a Physical Device
To delete an existing physical device, run the following command line:
Remove‐DAPhysicalDevice [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 31 Shell User’s Guide
C:\PS>Remove‐DAPhysicalDevice ‐Name 'physical device1'
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐Name Required Specifies the name of an existing physical device that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command without actually executing the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Logical Device
Refer to the section below for more information on the cmdlets’ usage for logical device.
Get a Blank Logical Device for Creating a New Logical Device
To get a blank logical device for creating a new logical device, run the following command line:
Get‐DABlankLogicalDevice [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DABlankLogicalDevice
Create a New Logical Device
To create a new logical device, run the following command line:
New‐DALogicalDevice [‐LogicalDevice] <LogicalDevice> [<CommonParameters>]
An example of the command is:
C:\PS>$device = Get‐DABlankLogicalDevice
C:\PS>$device.name = 'Logical Device'
C:\PS>$device.Description = 'Description'
C:\PS>$device.StorageType = 'NetShare'
C:\PS>$entity1 = New‐Object
Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 1')
C:\PS>$entity2 = New‐Object
Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 2')
C:\PS>$entity3 = New‐Object
Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 3')
C:\PS>$entity1.StorageData = $true
C:\PS>$entity1.StorageIndex = $false
C:\PS>$entity2.StorageData = $false
32 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
C:\PS>$entity2.StorageIndex =$true
C:\PS>$entity3.StorageData =$true
C:\PS>$entity3.StorageIndex =$true
C:\PS>$device.AddPhysicalDevice($entity1)
C:\PS>$device.AddPhysicalDevice($entity2)
C:\PS>$device.AddPhysicalDevice($entity3)
C:\PS>New‐DALogicalDevice ‐LogicalDevice $device
C:\PS
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐LogicalDevice Required Specifies a logical device object. About the structure and attribute of Logical Device, please refer to the SMSP SDK documentation for more information.
Get the Configuration Details of a Logical Device
To get the configuration details of a logical device, run the command below:
Get‐DALogicalDevice [[‐Name] <String[]>] [<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DALogicalDevice ‐Name 'logical device1'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies one or more logical device names. Multiple logical device names must be separated by commas. Wildcards are supported. If you do not specify any value for the parameter, the information of all the logical devices will be returned.
Update the Configurations of a Logical Device
To update the configurations of an existing logical device, run the command below:
Update‐DALogicalDevice [‐LogicalDevice] <LogicalDevice> [<CommonParameters>]
The example of the command is:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 33 Shell User’s Guide
C:\PS>$device = Get‐DALogicalDevice 'logical device1'
C:\PS>$device | fl
C:\PS>$device.RemovePhysicalDevice('physical device1')
C:\PS>$entity = New‐Object
Docave.Api.Controlpanel.StorageConfiguration.PhysicaldeviceEntity('physical device 2')
C:\PS>$entity.StorageIndex =$true
C:\PS>$entity.StorageData =$true
C:\PS>$device.AddPhysicalDevice($entity)
C:\PS>$device.PhysicalDeviceList | fl
C:\PS>Update‐DALogicalDevice $device
C:\PS>
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐LogicalDevice Required Specifies a logical device object to be updated.
Delete a Logical Device
To delete an existing logical device, run the following command:
Remove‐DALogicalDevice [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
C:\PS>Remove‐DALogicalDevice ‐Name 'physical device1'
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐Name Required Specifies the name of the logical device that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command without actually executing the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Storage Policy
Refer to the section below for more information on the cmdlets’ usage for storage policy.
Get a Blank Storage Policy for Creating a New Storage Policy
To get a blank storage policy for creating a new storage policy, run the following command:
Get‐DABlankStoragePolicy [<CommonParameters>]
34 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
An example of the command is:
C:\PS>Get‐DABlankStoragePolicy
Create a New Storage Policy
To create a new storage policy, run the following command:
New‐DAStoragePolicy [‐StoragePolicy] <StoragePolicy> [<CommonParameters>]
An example of the command is:
C:\PS>$policy = Get‐DABlankStoragePolicy
C:\PS>$policy.Name = 'storage policy 01'
C:\PS>$policy.Description = 'This is a new storage policy'
C:\PS>$policy.PrimaryStorage = 'logical device 01'
C:\PS>$policy.MediaServiceUseStrategy = 'CustomPriority'
C:\PS>$policy.MediaServiceNames.Add('service1')
C:\PS>$policy.MediaServiceNames.Add('service2')
C:\PS>New‐DAStoragePolicy ‐StoragePolicy $policy
C:\PS>
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐StoragePolicy Required Specifies a storage policy object. About the structure and attributes of the storage policy, refer to the SMSP SDK Documentation for more information.
Get the Configuration Details of a Storage Policy
To get the configuration details of a storage policy, run the following command:
Get‐DAStoragePolicy [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAStoragePolicy ‐Name 'storage policy'
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐Name Optional Specifies one or more storage policy names. Multiple storage policy names must be separated by commas. Wildcards are supported. If you do not type any value for the parameter, the information of all the storage policies will be returned.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 35 Shell User’s Guide
Update a Storage Policy
To update an existing storage policy, run the following command:
Update‐DAStoragePolicy [‐StoragePolicy] <StoragePolicy> [<CommonParameters>]
An example of the command is:
C:\PS>$policy = Get‐DAStoragePolicy ‐Name 'storage policy 1'
C:\PS>$policy.Name = 'storage policy 2'
C:\PS>$policy.Description = 'updates the storage policy'
C:\PS>$policy. MediaServiceUseStrategy ='DefaultPriority'
C:\PS>Update‐DAStoragePolicy ‐StoragePolicy $policy
C:\PS>
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐StoragePolicy Required Specifies an existing storage policy to be updated.
Delete a Storage Policy
To delete an existing storage policy according to the storage policy's name, run the following command:
Remove‐DAStoragePolicy [‐Name] <String> [‐WhatIf] [‐Confirm] [<CommonParameters>]
An example of the command is:
C:\PS>Remove‐DAStoragePolicy ‐Name 'storage policy'
To configure the command parameters, refer to the following table:
Parameter Type Comment
‐Name Required Specifies the name of a storage policy that you want to delete.
‐WhatIf Optional Describes what would happen if you executed the command without actually executing the command.
‐Confirm Optional Prompts you for confirmation before executing the command.
Update Manager
Refer to the section below for more information on the cmdlets’ usage in Update Manager.
Upload an Update in Update Manager
To upload a specified update, run the command below:
36 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Upload‐DAUpdate [‐Path] <String> [‐Overwrite] [<CommonParameters>]
An example of the command is:
C:\PS>Upload‐DAUpdate ‐Path 'C:\Hotfix_6.0.0.51008601.zip' ‐Overwrite
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Path Required Specifies the path of the update file.
‐Overwrite Optional Allows the cmdlet to overwrite an existing update.
Get an Update
To get all available updates for SnapManager for SharePoint Manager, run the command below:
Get‐DAUpdate [[‐Name] <String[]>] [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAUpdate ‐Name 'HotFix_6.0.0.51008601'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies one or more updates' names. You can type multiple update names (separated by commas). Wildcards are supported.
Obtain Update Configuration Information
To obtain general configuration information of an update, run the command below:
Get‐DAUpdateConfiguration [‐UpdateName] <String[]> [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAUpdateConfiguration ‐UpdateName Hotfix_6.0.0.51008601
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐UpdateName Required Specifies one or more updates' names. You can type multiple update names (separated by commas).
Test an Update
To test whether a specified update is valid before updating, run the command below:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 37 Shell User’s Guide
Test‐DAUpdate [‐Configuration] <UpdateConfiguration> [<CommonParameters>]
An example of the command is:
C:\PS>$config = Get‐DAUpdateConfiguration ‐UpdateName 'Hotfix_6.0.0.51008601'
C:\PS>$config.UpdateManager = $true
C:\PS>$config.ViewServiceForUpdate() Category: 127.0.0.1 WillUpdate: True Name: Control Service
Status: ACTIVE Version: 6.0.0.51008601 Type: Control Message: Ready for installing.
C:\PS>$config.UpdateNonFarmRelatedAgent = $true
C:\PS>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$config.UpdateSQLAgents.Add('SQL Agent'
C:\PS>Test‐DAUpdate ‐Configuration $config True
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Configuration Required Specifies an update configuration object.
Install an Update
To install an update, run the command below:
Install‐DAUpdate [‐Configuration] <UpdateConfiguration> [‐WhatIf] [‐Confirm]
[<CommonParameters>]Install‐DAUpdate [‐Configuration] <UpdateConfiguration> [‐WhatIf] [‐Confirm]
[<CommonParameters>]
An example of the command is:
C:\PS>$config = Get‐DAUpdateConfiguration ‐UpdateName 'Hotfix_6.0.0.51008601'
C:\PS>$config.UpdateManager = $true
C:\PS>$config.ViewServiceForUpdate()
C:\PS>$config.UpdateNonFarmRelatedAgent = $true
C:\PS>$config.UpdateFarms.Add('Farm(SP2010_DB:SHAREPOINT_CONFIG)')
C:\PS>$config.UpdateSQLAgents.Add('SQL Agent')
C:\PS>$config.RestartIIS = $true
C:\PS>Install‐DAUpdate ‐Configuration $config
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Configuration Required Specifies an update configuration object.
‐WhatIf Optional Describes what would happen if user executes the command without actually executing the command.
‐Confirm Optional Prompts user for confirmation before executing the command.
38 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 39 Shell User’s Guide
Storage Optimization
Refer to the section below for more information on the cmdlets’ usage in Storage Optimization.
BLOB Provider
Refer to the section below for more information on the cmdlets’ usage for BLOB Provider.
Obtain a Stub Database’s Configuration
To get configuration details of a stub database, run the command below:
Get‐DAStubDBConfiguration [‐FarmName] <String> [<CommonParameters>]
An example of the command is:
C:\PS>$StubDBConfig = Get‐DAStubDBConfiguration ‐FarmName
'Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$StubDBConfig.WebApplicationStubDBConfigurations
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐FarmName Required Specifies a farm name.
Configure a Stub Database
To configure a stub database for a farm, Web application, or content database, run the command below:
Configure‐DAStubDB [‐Configuration] <StubDBConfiguration> [<CommonParameters>]
The examples of the command are:
C:\PS>$StubDBConfig = Get‐DAStubDBConfiguration ‐FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)' C:\PS>$ContentDBs = $StubDBConfig.GetContentDBLevelStubDBConfigurationByName('WSS_Content_10001') C:\PS>$ContentDB1 = $ContentDBs[0] C:\PS>$ContentDB1.ConfigureAsWindowsAuthentication('DBServer','StubDB1') C:\PS>$ContentDB1.FailoverDatabaseServer = 'FailoverDBServer' C:\PS>Configure‐DAStubDB ‐Configuration $ContentDB1 C:\PS>$ContentDB2 = $StubDBConfig.GetContentDBLevelStubDBConfigurationById ("f17d7594‐d09a‐49a8‐b41a‐479a877a51d0") C:\PS>$password = Read‐Host ‐AsSecureString ******* C:\PS>$ContentDB2.ConfigureAsSQLAuthentication('DBServer','StubDB2','Username',$password)
40 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
C:\PS>$ContentDB2.FailoverDatabaseServer = 'FailoverDBServer' C:\PS>Configure‐DAStubDB ‐Configuration $ContentDB2
Or
C:\PS>$StubDBConfig = Get‐DAStubDBConfiguration ‐FarmName
'Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$WebAppConfig =
$StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/')
C:\PS>$password = Read‐Host ‐AsSecureString
*********
C:\PS>$WebAppConfig.ConfigureAsSQLAuthentication('DBServer','StubDB1','Username',$password)
C:\PS>Configure‐DAStubDB ‐Configuration $WebAppConfig
Or
C:\PS>$StubDBConfig = Get‐DAStubDBConfiguration ‐FarmName
'Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$WebAppConfig =
$StubDBConfig.GetWebApplicationLevelStubDBConfiguration('http://SharePoint2010:10001/')
C:\PS>$WebAppConfig.ConfigureByConnectionString('DataSource=myServerAddress;Failover
Partner=myMirrorServerAddress;Initial Catalog=myDataBase;Integrated Security=true;')
C:\PS>Configure‐DAStubDB ‐Configuration $WebAppConfig
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Configuration Required Specifies the stub database configuration. You can specify the farm level stub database configuration, Web application stub database configuration and content database stub database configuration.
Get Information About All BLOB Provider Binaries
To get information about all BLOB Provider binaries, run the command below:
Get‐DABLOBProviderBinariesInfo [[‐FarmName] <String>] [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DABLOBProviderBinariesInfo ‐FarmName 'Farm(SP2010_DB:SHAREPOINT_CONFIG)'To
configure the command parameters, refer to the table below.
Parameter Type Comment
‐FarmName Optional Specifies a farm name. If you do not set any value for the parameter, all of the farms' BLOB Provider
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 41 Shell User’s Guide
Parameter Type Comment
binaries’ information will be returned.
Get the BLOB Provider Configuration Details
To get the configuration details of the BLOB Provider, run the command below:
Get‐DABLOBProviderConfiguration [‐FarmName] <String> [<CommonParameters>]
An example of the command is:
C:\PS>$BLOB = Get‐DABLOBProviderConfiguration ‐FarmName'Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$BLOB.WebApplicationLevelRBSConfigurations
C:\PS> $BLOB.ContentDBLevelRBSConfigurations
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐FarmName Required Specifies a farm name.
Update BLOB Provider Settings
To update the BLOB Provider settings, run the command below:
Save‐DABLOBProviderConfiguration [‐Configuration] <BLOBProviderConfiguration> [‐RunNow]
[<CommonParameters>]
An example of the command is:
C:\PS>$BLOB = Get‐DABLOBProviderConfiguration ‐FarmName '
'Farm(SP2010_DB:SHAREPOINT_CONFIG)'
C:\PS>$ContentDB1 = $BLOB.GetContentDBLevelRBSConfigurationByName('WSS_Content_10001')
C:\PS>$ContentDB1.RBSEnabled = $true
C:\PS>$ContentDB2 = $BLOB.GetContentDBLevelRBSConfigurationById('f17d7594‐d09a‐49a8‐b41a‐
479a877a51d0')
C:\PS>$ContentDB2.RBSEnabled = $true
C:\PS>$ContentDB1
C:\PS>$ContentDB2
C:\>Save‐DABLOBProviderConfiguration ‐Configuration $BLOB
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Configuration Required Specifies the BLOB Provider configuration instance.
‐RunNow Optional Determines whether to run now after saving the
42 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Parameter Type Comment
configuration.
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 43 Shell User’s Guide
Archive Manager
Refer to the section below for more information on the cmdlets’ usage in Archiver.
Get Archiver Index Data Information
To get information on SnapManager for SharePoint Archive Manager Data that has not been successfully
indexed, run the command below:
Get‐DAArchiverIndexDataInfo [‐FarmName] <String> [‐OutPut] <String> [‐Overwrite]
[<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAArchiverIndexDataInfo ‐FarmName FarmA ‐OutPut C:\IndexInfo.xls
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐FarmName Required Specifies the name of a farm where the Archive Manager Data’s index information will be retrieved from.
‐OutPut Required Specifies a path to store the output file.
‐Overwrite Optional Overwrites the file if it already exists at the specified path.
Get an Archive Manager Job’s Detailed Information for Backup
To get detailed information on an Archive Manager job for backup, run the command below:
Get‐DAArchiverJobDetailForBackup [‐ID] <String> [‐JobReportDetailStatus <JobReportDetailStatus[]>]
[‐StartIndex <Int32>] [‐Length <Int32>] [<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DAArchiverJobDetailForBackup ‐ID AR20120710135406923230S
Or
C:\PS>Get‐DAArchiverJobDetailForBackup ‐ID AR20120710135406923230S ‐JobReportDetailStatus
Success,Failed ‐StartIndex 0 ‐Length 1
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐ID Required Specifies the job ID.
‐JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid
44 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Parameter Type Comment
values are “Success”, “Failed”, and “Skipped”.
‐StartIndex Optional Specifies the start number of the details that you want to get.
‐Length Optional Specifies the total number of details in the result.
Get an Archive Manager Job’s Detailed Information for Deletion
To get detailed information on an Archive Manager job for deletion, run the command below:
Get‐DAArchiverJobDetailForDeletion [‐ID] <String> [‐JobReportDetailStatus <JobReportDetailStatus[]>]
[‐StartIndex <Int32>] [‐Length <Int32>] [<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DAArchiverJobDetailForDeletion ‐ID AR20120710135855645356A0
Or
C:\PS>Get‐DAArchiverJobDetailForDeletion ‐ID AR20120710135855645356A0 ‐JobReportDetailStatus
Success,Failed ‐StartIndex 0 ‐Length 1
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐ID Required Specifies the job ID.
‐JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid values are “Success”, “Failed”, and “Skipped”.
‐StartIndex Optional Specifies the start number of the details that you want to get.
‐Length Optional Specifies the total number of details in the result.
Run Full Text Index Job
To run a full text index job, run the command below:
Run‐DAArchiverIndexJob ‐JobId <String> [<CommonParameters>]
An example of the command is:
C:\PS>Run‐DAArchiverIndexJob ‐JobId AI20120710135406923230
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐JobId Required Specifies an Archiver index job ID.
Run an Archive Manager Job
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 45 Shell User’s Guide
To run an Archive Manager job, run the command below:
Run‐DAArchiverJob [‐SPObject] <SharePointObject> [‐WaitForJobComplete] [<CommonParameters>]
An example of the command is:
C:\PS>$site1 = New‐Object DocAve.API.Objects.SharePointSite
('Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/sites/site1')
C:\PS>Run‐DAArchiverJob ‐SPObject $site1
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐SPObject Required The SharePoint object to be archived.
‐WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.
Set the Archive Manager Data Index Information
To set the index information of Archive Manager data that has not been successfully indexed, run the
command below:
Set‐DAArchiverIndexDataInfo [‐Path] <String> [‐OutPut] <String> [‐Overwrite] [<CommonParameters>]
An example of the command is:
C:\PS>Set‐DAArchiverIndexDataInfo ‐Path
C:\IndexInfo.xls ‐OutPut
C:\Result.xls
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Path Required Specifies a path to load the file storing the Archive Manager data’s index information.
‐OutPut Required Specifies a path to store the output file.
‐Overwrite Optional Overwrites the file if it already exists at the specified path.
46 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Real‐Time Storage Manager
Refer to the section below for more information on the cmdlets’ usage in Real‐Time Storage Manager.
Get a Blank Real‐Time Storage Manager Rule
To get a blank Real‐time Storage Manager rule, run the command below:
Get‐DARealtimeStorageManagerBlankRule [<CommonParameters>]
An example of the command is:
C:\PS>$rule = Get‐DARealtimeStorageManagerBlankRule
Get a Real‐Time Storage Manager Rule
To get the configurations of a Real‐time Storage Manager rule, run the command below:
Get‐DARealtimeStorageManagerRule [‐Name <String>] [<CommonParameters>]
Get‐DARealtimeStorageManagerRule [‐SPContentDB <SharePointContentDB>]
[<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DARealtimeStorageManagerRule
Or
C:\PS>Get‐DARealtimeStorageManagerRule ‐Name 'rule2'
Or
C:\PS>$db = New‐Object DocAve.API.Objects.SharePointContentDB
'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001'
C:\PS>Get‐DARealtimeStorageManagerRule ‐SPContentDB $db
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Optional Specifies the name of the Real‐time Storage Manager rule whose configurations will be obtained.
‐SPContentDB Optional Specifies a SharePoint content database. All Real‐time Storage Manager rules that have been applied to this specified database will be obtained.
‐SPWebApplication Optional Specifies a SharePoint Web application. All Real‐time Storage Manager rules that have been
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 47 Shell User’s Guide
Parameter Type Comment
applied to this specified Web application will be obtained.
‐SPSite Optional Specifies a SharePoint site collection. All Real‐Time Storage Manager rules that have been applied to this specified site collection will be obtained.
Create a Real‐Time Storage Manager Rule
To create a Real‐time Storage Manager rule, run the command below:
New‐DARealtimeStorageManagerRule [‐Rule] <RealtimeStorageManagerRule>
[<CommonParameters>]
An example of the command is:
C:\PS>$rule = Get‐DARealtimeStorageManagerBlankRule
C:\PS>$rule. Name = ‘rule1’
C:\PS>$rule.SizeThreshold = '768kb' C:\PS>$rule.LogicalDeviceName = 'logical device1'
C:\PS>$rule.CompressionLevel = 'level3' C:\PS>$rule.EnableDataEncryption('MyProfile')
C:\PS>New‐DARealtimeStorageManagerRule $rule
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Rule Required Specifies a real‐time storage manager rule object where you can create a new real‐time storage manager rule.
Retract a Real‐Time Storage Manager Rule
To retract an existing Real‐time Storage Manager rule from the specified SharePoint content database,
Web application, or site collection, run the command below:
Retract‐DARealtimeStorageManagerRule [‐RuleName] <String> [‐SPContentDB]
<SharePointContentDB> [<CommonParameters>]
The example of the command:
C:\PS>$db = New‐Object DocAve.API.Objects.SharePointContentDB
'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001'
C:\PS>Retract‐DARealtimeStorageManagerRule ‐RuleName 'rule1' ‐SPContentDB $db
48 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐RuleName Required Specifies the name of the Real‐Time Storage Manager rule that you want to retract from the specified SharePoint content database.
‐SPContentDB Required Specifies a SharePoint content database where the specified Real‐Time Storage Manager rule will be retracted.
‐SPWebApplication Optional Specifies a SharePoint Web application where the specified Real‐Time Storage Manager rule will be retracted.
‐SPSite Optional Specifies a SharePoint site collection where the specified Real‐Time Storage Manager rule will be retracted.
Reuse a Real‐Time Storage Manager Rule
To reuse an existing Real‐time Storage Manager rule, run the command below:
Reuse‐DARealtimeStorageManagerRule [‐RuleName] <String> [‐SPContentDB]
<SharePointContentDB> [<CommonParameters>]
The example of the command:
C:\PS>$db = New‐Object DocAve.API.Objects.SharePointContentDB
'Farm(SP2010_DB:SHAREPOINT_CONFIG)','http://SharePoint2010:10001/', 'wss_content_10001'
C:\PS>Reuse‐DARealtimeStorageManagerRule ‐RuleName 'rule1' ‐SPContentDB $db
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐RuleName Required Specifies the name of the Real‐Time Storage Manager rule that you want to reuse.
‐SPContentDB Required Specifies a SharePoint content database where the specified Real‐Time Storage Manager rule will be applied.
‐SPWebApplication Optional Specifies a SharePoint Web application where the specified Real‐Time Storage Manager rule will be applied.
‐SPSite Optional Specifies a SharePoint site collection where the specified Real‐Time Storage Manager rule will be applied.
Delete a Real‐time Storage Manager Rule
To delete a Real‐time Storage Manager rule, run the command below:
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 49 Shell User’s Guide
Remove‐DARealtimeStorageManagerRule [‐Name] <String> [<CommonParameters>]
An example of the command is:
C:\PS>Remove‐DARealtimeStorageManagerRule ‐Name 'rule1'
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Name Required Specifies the name of a Real‐time Storage Manager rule that you want to delete.
Update the Configurations of a Real‐time Storage Manager Rule
To update the configurations of an existing Real‐time Storage Manager rule, run the command below:
Update‐DARealtimeStorageManagerRule [‐Rule] <RealtimeStorageManagerRule> [<
CommonParameters>]
An example of the command is:
C:\PS>$rule = Get‐DARealtimeStorageManagerRule ‐Name 'rule1'
C:\PS>$rule.Name = 'rule2'
C:\PS>$rule.CompressionLevel = 'level7'
C:\PS>Update‐DARealtimeStorageManagerRule $rule
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐Rule Required Specifies a Real‐Time Storage Manager rule object whose configurations will be updated.
50 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Data Protection
Refer to the section below for more information on the cmdlets’ usage in Data Protection.
Platform Backup and Restore
Refer to the section below for more information on the cmdlets’ usage in Platform Backup and Restore.
Get the Default Settings of an SMSP Platform Backup Plan
To get the default settings of a SMSP Platform Backup plan, run the command below:
Get‐DASMSPPlatformBackupJobConfiguration [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DASMSPPlatformBackupJobConfiguration
Run a SMSP Platform Backup Job
To run an existing SnapManager Platform Backup and Restore plan, run the command below:
Run‐DASMSPPlatformBackupJob [‐PlanName] <String> [‐JobConfiguration]
<SMSPPlatformBackupJobConfiguration> [‐WaitForJobComplete] [<CommonParameters>]
Run‐DASMSPPlatformBackupJob [‐PlanName] <String> [[‐TestRun]] [‐WaitForJobComplete]
[<CommonParameters>]
An example of the command is:
C:\PS>$info = Get‐DASMSPPlatformBackupJobConfiguration
C:\PS>$info.RestoreGranularLevel = 'SiteLevel'
C:\PS>$info.DeferIndexingToMaintenanceJobs = $true
C:\PS>$info.BackupConnectorBLOB = $true
C:\PS
C:\PS>Run‐DASMSPPlatformBackupJob ‐PlanName 'plan1' ‐JobConfiguration $info ‐
WaitForJobComplete
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐PlanName Required Specifies the plan name, and the job will run based on the plan.
‐JobConfiguration Required This parameter is optional when the TestRun parameter is used. Specify the job configuration variable that contains the backup job settings you
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 51 Shell User’s Guide
Parameter Type Comment
want to use.
‐TestRun Optional This parameter is optional when the JobConfiguration parameter is used. Enter this parameter to simulate the execution of the selected plan.
‐WaitForJobComplete Optional Specifies whether to wait for the completion of the job. If so, the job process will be displayed and another job cannot be run until this job has completed; if not, the job will run in the background and you can run another job without waiting for the completion of this job.
Job Monitor
Refer to the section below for more information on the cmdlets’ usage in Job Monitor.
Obtain a Specified Module’s Job
To get a job of a specified module, run the command below:
Get‐DAJob [‐ID] <String> [<CommonParameters>]
Get‐DAJob [‐Module] <Module> [‐StartTimeRangeBeginning <DateTime>] [‐StartTimeRangeEnding
<DateTime>] [<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DAJob ‐Id CA20120710105416471063
Or
C:\PS>Get‐DAJob ‐Module Administrator
Or
C:\PS>Get‐DAJob ‐Module Administrator ‐StartTimeRangeBeginning "7/10/2012 10:10" ‐
StartTimeRangeEnding "7/10/2012 10:58"
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐ID Required Specifies the job ID.
‐Module Required Specifies the job's module. Valid values are "PlatformBackup", "PlatformRestore", "PlatformMaintenanceManager", "Retention", "FarmRebuild", "PlatformIndexMigration", "Archiver",
52 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Parameter Type Comment
"ArchiverFullTextIndex", "ArchiverRestore", "ArchiverRetention", "ConvertStubToContent", "ScheduledStorageManager", "Connector", "OrphanBLOBRetention", "LogManager", "JobPruning", “EndUserArchiver", "EndUserRestore", "DataManager"
‐StartTimeRangeBeginning Optional Specifies the beginning of job start time range. The type must be a valid DateTime format that is culture‐specific to the administrative language, such as 2/16/2010 12:15:12 for English‐US. If you do not specify the time range, the job information will not be filtered according to job start time.
‐StartTimeRangeEnding Optional Specifies the end of job start time range. The type must be a valid DateTime format that is culture‐specific to the administrative language, such as 2/16/2010 12:15:12 for English‐US. If you do not specify the time range, it will not filter the job information according to job start time.
Obtain a Job’s Detailed Information
*Note: This cmdlet cannot get the details of the Archive Manager jobs.
An error may occur if the job detail has a very large amount of data. Please use parameters StartIndex
and Length and set the suitable values to limit the data size of job detail obtained at a time.
To get detailed information on the items included in a job (such as item type, source URL, destination
URL, etc.), run the command below:
Get‐DAJobDetail [‐ID] <String> [‐JobReportDetailStatus <JobReportDetailStatus[]>] [‐StartIndex
<Int32>] [‐Length <Int32>] [<CommonParameters>]
The examples of the command are:
C:\PS>Get‐DAJobDetail ‐ID CM20111011115232293242
Or
C:\PS>Get‐DAJobDetail ‐ID CM20111011115233293432 ‐JobReportDetailStatus Success,Failed ‐
StartIndex 0 ‐Length 1
To configure the command parameters, refer to the table below.
Parameter Type Comment
IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management 53 Shell User’s Guide
Parameter Type Comment
‐ID Required Specifies the job ID.
‐JobReportDetailStatus Optional Specifies the detail status to filter the detail. Valid values are “Success”, “Failed”, “Skipped”, and “Filtered”.
‐StartIndex Optional Specifies the start number of the details.
‐Length Optional Specifies the total number of details in the result.
Obtain a Job’s Summary Information
To get a job summary, run the command below:
Get‐DAJobSummary [‐ID] <String> [<CommonParameters>]
An example of the command is:
C:\PS>Get‐DAJobSummary ‐ID CA20120710105416471063
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐ID Required Specifies the job ID.
Download a Job Report
To download a job report, run the command below:
Download‐DAJobReport [‐ID] <String> [‐Format <JobReportFormat>] ‐Path <String> [‐Overwrite]
[<CommonParameters>]
An example of the command is:
C:\PS>Download‐DAJobReport ‐ID FB20120627174730343482 ‐Path 'C:\Report.zip'‐Format txt ‐
Overwrite
To configure the command parameters, refer to the table below.
Parameter Type Comment
‐ID Required Specifies the job ID.
‐Format Optional Specifies the format of the report. Valid values are “XLS”, “CSV”, and “TXT”. If the job is a Log Manager job, this parameter is ignored.
‐Path Required Specifies the path of the report file.
‐Overwrite Optional Allows the cmdlet to overwrite an existing file.
54 IBM System Storage N series SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
Copyright and trademark information
Copyright ©1994 - 2013 NetApp, Inc. All rights reserved. Printed in the U.S.A.
Portions copyright © 2013 IBM Corporation. All rights reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restrictedby GSA ADP Schedule Contract with IBM Corp.
No part of this document covered by copyright may be reproduced in any form orby any means— graphic, electronic, or mechanical, including photocopying,recording, taping, or storage in an electronic retrieval system—without priorwritten permission of the copyright owner.
References in this documentation to IBM products, programs, or services do notimply that IBM intends to make these available in all countries in which IBMoperates. Any reference to an IBM product, program, or service is not intended tostate or imply that only IBM’s product, program, or service may be used. Anyfunctionally equivalent product, program, or service that does not infringe any ofIBM’s or NetApp’s intellectual property rights may be used instead of the IBM orNetApp product, program, or service. Evaluation and verification of operation inconjunction with other products, except those expressly designated by IBM andNetApp, are the user’s responsibility.
No part of this document covered by copyright may be reproduced in any form orby any means— graphic, electronic, or mechanical, including photocopying,recording, taping, or storage in an electronic retrieval system—without priorwritten permission of the copyright owner.
Software derived from copyrighted NetApp material is subject to the followinglicense and disclaimer:
THIS SOFTWARE IS PROVIDED BY NETAPP "AS IS" AND WITHOUT ANYEXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE, WHICH ARE HEREBY DISCLAIMED. IN NO EVENTSHALL NETAPP BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUTNOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVERCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IFADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
NetApp reserves the right to change any products described herein at any time,and without notice. NetApp assumes no responsibility or liability arising from theuse of products described herein, except as expressly agreed to in writing byNetApp. The use or purchase of this product does not convey a license under anypatent rights, trademark rights, or any other intellectual property rights of NetApp.
The product described in this manual may be protected by one or more U.S.A.patents, foreign patents, or pending applications.
© Copyright IBM Corp. 2013 55
RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by thegovernment is subject to restrictions as set forth in subparagraph (c)(1)(ii) of theRights in Technical Data and Computer Software clause at DFARS 252.277-7103(October 1988) and FAR 52-227-19 (June 1987).
Trademark informationIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corporation in the United States, other countries,or both. A complete and current list of other IBM trademarks is available on theWeb at http://www.ibm.com/legal/copytrade.shtml
Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and othercountries.
NetApp, the NetApp logo, Network Appliance, the Network Appliance logo,Akorri, ApplianceWatch, ASUP, AutoSupport, BalancePoint, BalancePoint Predictor,Bycast, Campaign Express, ComplianceClock, Cryptainer, CryptoShred, CyberSnap,Data Center Fitness, Data ONTAP, DataFabric, DataFort, Decru, Decru DataFort,DenseStak, Engenio, Engenio logo, EStack, ExpressPod, FAServer, FastStak,FilerView, Flash Accel, Flash Cache, Flash Pool, FlashRay, FlexCache, FlexClone,FlexPod, FlexScale, FlexShare, FlexSuite, FlexVol, FPolicy, GetSuccessful, gFiler, Gofurther, faster, Imagine Virtually Anything, Lifetime Key Management, LockVault,Mars, Manage ONTAP, MetroCluster, MultiStore, NearStore, NetCache, NOW(NetApp on the Web), Onaro, OnCommand, ONTAPI, OpenKey, PerformanceStak,RAIDDP, ReplicatorX, SANscreen, SANshare, SANtricity, SecureAdmin,SecureShare, Select, Service Builder, Shadow Tape, Simplicity, Simulate ONTAP,SnapCopy, Snap Creator, SnapDirector, SnapDrive, SnapFilter, SnapIntegrator,SnapLock, SnapManager, SnapMigrator, SnapMirror, SnapMover, SnapProtect,SnapRestore, Snapshot, SnapSuite, SnapValidator, SnapVault, StorageGRID,StoreVault, the StoreVault logo, SyncMirror, Tech OnTap, The evolution of storage,Topio, VelocityStak, vFiler, VFM, Virtual File Manager, VPolicy, WAFL, Web Filer,and XBB are trademarks or registered trademarks of NetApp, Inc. in the UnitedStates, other countries, or both.
All other brands or products are trademarks or registered trademarks of theirrespective holders and should be treated as such.
NetApp, Inc. is a licensee of the CompactFlash and CF Logo trademarks.
NetApp, Inc. NetCache is certified RealSystem compatible.
NoticesThis information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBM
56 IBM System Storage N series: SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
product, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe on any IBM intellectual property rightmay be used instead. However, it is the user’s responsibility to evaluate and verifythe operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents. You can send license inquiries, in writing to:
IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, N.Y. 10504-1785U.S.A.
For additional information, visit the web at:http://www.ibm.com/ibm/licensing/contact/
The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of expressor implied warranties in certain transactions, therefore, this statement may notapply to you.
This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.
Any references in this information to non-IBM web sites are provided forconvenience only and do not in any manner serve as an endorsement of those websites. The materials at those web sites are not part of the materials for this IBMproduct and use of those web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.
Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.
Copyright and trademark information 57
If you are viewing this information in softcopy, the photographs and colorillustrations may not appear.
58 IBM System Storage N series: SnapManager 8.0 for Microsoft SharePoint SDK Management Shell User’s Guide
����
NA 21006221_A0, Printed in USA
SC27-5428-01