TOP / テクニック
- 1 2 3 4 5.. >>

2015年02月16日

PowerShell スクリプト集 「カスタム テンプレートからのサイト作成」

こんばんは、ソノリテの費です。

SharePoint 2013 でのカスタム テンプレートによるサイト コレクションの作成を行う PowerShell スクリプトを作成しました。

SharePoint2013_SelectTemplate_Custom.png


  • カスタム テンプレートによるサイト コレクション作成について

    • SharePoint 2007 までは、予めカスタム テンプレートをファームに登録して、サイト コレクション作成時にそのテンプレートを選択出来ていました。
    SharePoint 2010 でも古い形式のテンプレートであれば、Install-SPWebTemplate コマンドレットを使って、ファームに登録することが出来ましたが、SharePoint 2013 では、そもそも Install-SPWebTemplate コマンドレットが利用出来なくなっています。

    Web UI からのサイト コレクション作成の場合は、テンプレートを指定しないでサイト コレクションを作成してから、ソリューション ギャラリーにテンプレートをアップロードして適用するというアプローチになります。
    このアプローチは少々面倒ですよね。
    そこで、PowerShell なら少しは手間が省けるかなと思った訳です。


  • Web UI での手順について

    • 今更ではありますが、サーバーの全体管理などの Web UI からの手順は以下のようになります。

    ちなみに、SharePoint 2010 までは、実際に「空のサイト」というテンプレートがあったので紛らわしかったです。
    英語では、「空のサイト」テンプレートを Blank Site、そして、テンプレートを指定しないサイトを Empty Site と呼んでいました。

    サイト コレクション作成時には、「テンプレートの選択」にて、「ユーザー設定」タブの「< テンプレートを後で選択... >」を選択しておきます。
    SharePoint2013_CreateSite_EmptySite.png

    作成された結果のサイト コレクションにアクセスすると、引き続き、以下のようなサイト テンプレート選択のページが表示されますが、その下の「ソリューション ギャラリー」を選択します。
    SharePoint2013_SelectTemplate.pngo

    「ソリューション ギャラリー」のページにて、「ソリューションのアップロード」を選択します。
    SharePoint2013_SolutionGallery.png

    「ソリューションの追加」Web ダイアログにて、予め作成してダウンロードしてあるカスタム テンプレート (.wsp) ファイルを選択してアップロードを行います。
    SharePoint2013_AddUserSolution.png

    アップロードが終わると、続いて、「ソリューションのアクティブ化」Web ダイアログが表示されるので、「アクティブ化」を選択します。
    SharePoint2013_ActivateUserSolution.png

    これで、「ソリューション ギャラリー」に「アクティブ化」された状態のカスタム テンプレートが登録された状態となります。
    SharePoint2013_SolutionGallery2.png

    もう一度、作成されたサイト コレクションの URL にアクセスして、「テンプレートの選択」で「ユーザー設定」タブを選択すると、登録したカスタム テンプレートが選択出来る状態となっています。
    SharePoint2013_SelectTemplate_Custom.png

    適用が終わると、無事にカスタム テンプレートに基づくサイト コレクションが出来上がります。
    SharePoint2013_CustomProjectSite.png


  • PowerShell での作成について

    • PowerShell でも、基本的には Web UI での操作と同等のことをコマンドレット、および、API を利用して行います。

    最初に、テンプレートを指定せずに、サイトコレクションを作成します。

    $site = New-SPSite -Url $Url -OwnerAlias $OwnerAlias -Name $Name

    次に、ソリューション ギャラリーにカスタム テンプレートを追加して、アクティブ化を行います。

    Add-SPUserSolution -LiteralPath $LiteralPath -Site $site.Url
    $solution = Get-SPUserSolution -Site $site.Url
    $solution = Install-SPUserSolution -Identity $solution.Name -Site $site.Url

    最後に、サイト コレクションのトップレベル サイトに、追加されたカスタム テンプレートの適用を行います。

    $template = $site.GetWebTemplates(1041) |
    		Where-Object { $_.GetType().Name -eq "SPFeatureWebTemplate" }
    $web = $site.RootWeb
    $web.ApplyWebTemplate($template.Name)

    PowerShell だと 7行で終わってしまう所が素晴らしい。

    ちなみに、SharePoint 2013 用として作成していましたが、SharePoint 2010 でも動きそうなので、両方の対応としています。
    ところが、SharePoint 2013 と SharePoint 2010 ではテンプレートのプロパティの値が異なるようで、SharePoint 2013 で利用出来た IsCustomTemplate で区別が出来なかったので、暫定的に、オブジェクトの型 (クラス名) で区別するようにしています。


  • カスタム テンプレートからのサイト作成用 PowerShell スクリプト

    • 作成した PowerShell スクリプトはこちらになります。
    SharePoint 2013 と SharePoint 2010 で動作することを確認済みです。

    New-SPSiteFromCustomTemplate.ps1

    -Url: サイト コレクションの URL (必須)
    -OwnerAlias: サイト コレクション の管理者 (必須)
    -LiteralPath: カスタム テンプレートのファイル パス (必須)
    -Name: サイト コレクションのタイトル (オプション)


  • 参考リソース

    • ・Using a site template with a new site collection in SharePoint Online
    http://blog.ciaops.com/2013/07/using-site-template-with-new-site.html

    ・Add-SPUserSolution
    https://technet.microsoft.com/ja-jp/library/ff607715.aspx
    ・Install-SPUserSolution
    https://technet.microsoft.com/ja-jp/library/ff607653.aspx


今回のスクリプトには全く反映出来ていませんが、PowerShell スクリプトで引数を必須にするとか、いろいろと定義が出来るんですね・・・

Kokuho Hi (Sonorite / SharePoint Technology Center)

タグ：Powershell SharePoint 2013 サンプルコード SharePoint 2010
posted by kunitaka at 23:44| Comment(0) | テクニック

2015年02月12日

PowerShell スクリプト集 「サイトの権限一覧取得」

こんばんは、ソノリテの費です。

ちょっと汎用的な PowerShell スクリプトのひな形を作ってみようと思い、少しお作法勉強しました。
題材に取り上げたのは、サイトの権限一覧取得です。

SharePoint2013_SitePermissions.png


  • PowerShell スクリプトでの引数

    • PowerShell でコマンドレットを使う時に、コマンドレットの名前だけでなく、引数の名前もタブ補完で補ってくれます。
    これ、PowerShell スクリプトでも同じことが出来るようです。

    ポイントは、Param ステートメントで、スクリプトファイルの先頭に定義するだけです。

    Param(
    	[string]$Identity,
    	[string]$ContentDatabase,
    	[string]$WebApplication,
    	[switch]$Allwebs
    )

    これで、-Identity とか、-WebApplication を -I や -W の入力でタブ補完が利用出来るようになります。
    分かり易い長い引数名を付けても、これで引数の指定がとても楽になります。


  • サイトの権限取得

    • いわゆる、「サイトの設定」ページの「ユーザーと権限」セクションの中の「サイトの権限」で表示される内容を取得するのが、今回の PowerShell スクリプトのゴールです。

    SharePoint2013_SiteSettings_SitePermissions.png

    これには、SPWeb クラスの RoleAssignments プロパティを参照すれば良いようです。

    ・SPSecurableObject.RoleAssignments property
    https://msdn.microsoft.com/EN-US/library/microsoft.sharepoint.spsecurableobject.roleassignments.aspx

    また、種類 (SharePoint グループ、ドメイン グループ、ユーザー) については、以下のようなロジックで判別出来るようです。

    if ($assignments.Member.XML.StartsWith('<Group') -eq "True") {
    	$type = "SharePoint グループ"
    } elseif ($assignments.Member.IsDomainGroup) {
    	$type = "ドメイン グループ"
    } else {
    	$type = "ユーザー"
    }

    SharePoint グループの判別が、XML の文字列内容で判断するというのが、今一つという気もしますが、ここでは、要件が満たせれば良いことにします。


  • PowerShell ユーザーオブジェクトの作成

    • 今まで、結果の出力には文字列を作って表示というお気楽なことをやっていましたが、PowerShell ではパイプ処理にて折角オブジェクトが使われるので、それが活かせるようにオブジェクトに展開して出力させるようにしました。

    とは言え、難しいことはなく、New-Object で PSObject を生成すれば良く、後はプロパティ名と名前を連想配列で指定するだけです。

    $results += New-Object PSObject -Property @{
    				Url = $web.Url;
    				Name = $assignments.Member.Name;
    				Type = $type;
    				Role = $role
    			} | Select-Object Url, Name, Type, Role

    但し、PowerShell のバージョンによっては、プロパティ名の順序が定義通りにならない場合があるので、Select-Object で指定するのが望ましいようです。


  • サイトの権限取得用 PowerShell スクリプト

    • 作成した PowerShell スクリプトはこちらになります。
    SharePoint 2013 と SharePoint 2010 で動作することを確認済みです。

    Get-SitePermissions.ps1

    Get-SitePermissions.png

    オブジェクトとして出力しているので、| (パイプ) で繋いで、Export-Csv コマンドレットを利用して CSV ファイルに出力することも可能です。
    get-SPSite コマンドレットに準じて、個別サイトコレクション、コンテンツデータベース内のサイトコレクション、Web アプリケーション内のサイトコレクション、そして、全てのサブサイトのサイトの権限一覧の出力が可能です。


  • 参考リソース

    • 今回、PowerShell スクリプトを作成するのに、幾つか参考にした記事はこちらです。
    感謝ですね。

    ・[PowerShell] PS1 ファイル実行時にとる引数をコマンドレットみたいにタブ補完したい！
    http://blogs.technet.com/b/jpilmblg/archive/2011/03/09/powershell-ps1.aspx
    ・連想配列を変換してユーザー定義オブジェクトを簡単に作成する
    http://winscript.jp/powershell/227
    ・配列 (Windows PowerShell)
    http://ufcpp.net/study/powershell/array.html
    ・Change order of columns in the object
    http://stackoverflow.com/questions/19624597/change-order-of-columns-in-the-object

    権限が付与されているオブジェクトの種類を判別するロジックについては、こちらを参考にしました。
    なるほど！、と思いました。

    ・PowerShell Script to Enumerate SharePoint 2010 or 2013 Permissions and Active Directory Group Membership
    http://geekswithblogs.net/bjackett/archive/2013/07/01/powershell-script-to-enumerate-sharepoint-2010-or-2013-permissions-and.aspx


ついつい、形から入る私は、どうせやるなら、ひな形というかスタイルを確立してから、いろいろと展開したいと思ってしまうのでした。

Kokuho Hi (Sonorite / SharePoint Technology Center)

タグ：Powershell SharePoint 2013 サンプルコード SharePoint 2010
posted by kunitaka at 00:10| Comment(0) | テクニック

2015年02月06日

SharePoint 検証環境構築 〜SharePoint Server 2007〜

こんばんは、ソノリテの費です。

SharePoint 2010 に続いて、SharePoint 2007 の検証環境を作りました。　恐らく、６年ぶり位かもしれません・・・

SharePoint2007_SetupGuide.png


  • SharePoint Server 2007 SP3 スリップストリーム イメージ

    • 今回、Windows Server 2008 R2 の仮想マシンイメージ上にセットアップすることにしていたので、SharePoint Server 2007 としては SP2 が不可欠です。
    実際には、既に SP3 がリリースされているので、最初から SP3 をセットアップすることにしました。

    ところが、MSDN サブスクリプションには、SP3 が含まれたパッケージは無いんですよね。
    日本語版は SP1 が含まれたパッケージしかありませんでした。

    仕方が無いので、自分で SP3 を含むスリップストリーム イメージを作成します。

    ・Slipstreaming SP2 into SharePoint Server 2007
    http://blogs.technet.com/b/seanearp/archive/2009/05/20/slipstreaming-sp2-into-sharepoint-server-2007.aspx

    と言っても難しいことはなく、RTM 版のインストール イメージをディスクに展開して、SharePoint Server 2007 と WSS 3.0 の SP3 モジュールをダウンロードして、exe の中から個別のインストール パッケージを取り出します。

    ・Windows SharePoint Services Service Pack 3 (SP3)
    http://www.microsoft.com/ja-jp/download/details.aspx?id=10404
    ・2007 Microsoft Office Servers Service Pack 3 (SP3) (64 ビット版)
    http://www.microsoft.com/ja-jp/download/details.aspx?id=27803

    取り出しには、以下のようにダウンロードした exe にオプションを指定して実行します。

    WSSSP3-KB923643-FullFile-JPN.exe /extract:c:\temp
    officeserver2007sp3-kb2526299-x64-fullfile-ja-jp.exe /extract:c:\temp

    展開したファイルの中で、Wsssetup.dll を削除します。
    その後、ディスク上に展開した RTM 版の Updates フォルダに、取り出したファイル一式をコピーします。

    これで、SharePoint Server 2007 with SP3 のセットアップ イメージが出来上がります。


  • SharePoint Server 2007 のセットアップ

    • 今更、SharePoint 2007 のセットアップについて、詳しく書いても仕方が無いので、詳しい手順などは導入と構成ガイドにお任せします。
    と、思っていたのですが、現在、「Microsoft Office SharePoint Server 2007 導入と構成ガイド」はダウンロード出来なくなっているようです。

    とは言え、導入と構成ガイドでは、SharePoint 2007 のセットアップ部分については、細かく記載されているのですが、事前の準備の部分がほとんど書かれていないため、今では、TechNet のリソースを参照するのが良いのかも知れません。

    ・サーバー ファーム環境に Office SharePoint Server 2007 をインストールする
    https://technet.microsoft.com/ja-jp/library/cc262079(v=office.12).aspx
    ・共有サービス プロバイダを作成および構成する
    https://technet.microsoft.com/ja-jp/library/cc303421(v=office.12).aspx
    ・その他の構成タスクを実行する (Office SharePoint Server
    https://technet.microsoft.com/ja-jp/library/cc303418(v=office.12).aspx
    ・SharePoint サイトを展開および構成する
    https://technet.microsoft.com/ja-jp/library/cc303408(v=office.12).aspx

    今回は、OS は仮想マシン イメージから構成して、その上に、SQL Server 2008 R2 をセットアップ、Web サーバーとアプリケーション サーバーの役割を追加して、構成ウィザードを実行します。
    その後、共有サービス プロバイダを構成して、ユーザープロファイルの同期、検索の設定してから、サイト コレクション構成用の Web アプリケーションを作成して、サイト コレクションの作成まで行っておきます。

    手順を確認しながら、段々記憶が蘇ってきます。
    昔は、1つ1つ、設定作業を行う必要がありましたね。

    SharePoint 2010 以降は、サーバーの全体管理での構成ウィザードの実行により、検証環境ならかなり自動化されているので、それに比べると、随分、面倒だったなと思い出しました。
    思い出しついでに、自分でもセットアップ手順書を画面キャプチャ付きで作っていたのを、このブログ記事を書いている時に思い出しました。
    セットアップ完了後なので、もう、遅いですって・・・

    手間は掛かりますが、手順さえ間違えなければ、はまるポイントは基本的に無かったと思います。
    唯一、サーバーの役割をきちんと構成しておくって所だけでしょうか。

    ・MOSS 2007 を Windows Server 2008（R2含む）に導入する場合の注意事項
    http://blogs.technet.com/b/sharepoint_support/archive/2010/03/02/moss-2007-windows-server-2008-r2.aspx

    ということで、出来上がった仮想マシンの PC のプロパティを確認すると以下のようになります。

    pc_property_sysprep2.png

    そして、立ち上がったサーバーの全体管理がこちら。

    SharePoint2007-CentralAdministration.png

    これで、検証環境については、SharePoint 2007 から SharePoint 2013 までのシングルサーバー環境が揃いました。

    Hyper-VEnvironment2.png


検証環境を作りながら、案件対応しているうちに、SQL Server 2012 での可用性構成も触っておくべきだなと思いました。
ということで、今後 SharePoint 2013 のサーバーファーム環境を構築する予定なのですが、その中でデータベースサーバーについても、今更、クラスタ構成も無いだろうと思って、AlwaysOn 可用性グループの構成を作ることにしました。

Kokuho Hi (Sonorite / SharePoint Technology Center)

タグ：サービスパック SharePoint 2007 Windows Server
posted by kunitaka at 22:09| Comment(0) | テクニック
- 1 2 3 4 5.. >>