Linux 用 DSC の nxFile リソース

[アーティクル]
03/09/2024

PowerShell Desired State Configuration (DSC) の nxFile リソースは、Linux ノード上でファイルとディレクトリを管理するためのメカニズムを備えています。

構文

nxFile <string> #ResourceName
{
    DestinationPath = <string>
    [ SourcePath = <string> ]
    [ Type = <string> { directory | file | link } ]
    [ Contents = <string> ]
    [ Checksum = <string> { ctime | mtime | md5 }  ]
    [ Recurse = <bool> ]
    [ Force = <bool> ]
    [ Links = <string> { follow | manage | ignore } ]
    [ Group = <string> ]
    [ Mode = <string> ]
    [ Owner = <string> ]
    [ DependsOn = <string[]> ]
    [ Ensure = <string> { Absent | Present }  ]
}

Properties

プロパティ	説明
DestinationPath	ファイルまたはディレクトリの状態を保証する場所を指定します。
SourcePath	ファイルまたはフォルダーリソースのコピー元のパスを指定します。このパスはローカルパスまたは `http/https/ftp` URL です。リモート `http/https/ftp` URL は、Type プロパティの値が file の場合にのみサポートされます。
型	構成されるリソースがディレクトリまたはファイルのいずれであるかを指定します。リソースがディレクトリであることを示すには、このプロパティを directory に設定します。リソースがファイルであることを示すには、file に設定します。既定値は file です。
内容	特定の文字列など、ファイルの内容を指定します。
Checksum	2 つのファイルが同じであるかどうかを決定するときに使用するタイプを定義します。 Checksum が指定されていない場合、ファイルまたはディレクトリ名のみが比較に使用されます。値は、ctime、mtime、または md5 です。
Recurse	サブディレクトリが含まれるかどうかを示します。サブディレクトリを含めるようにするには、このプロパティを `$true` に設定します。既定では、 `$false`です。このプロパティは、Type プロパティが directory に設定されている場合にのみ有効です。
Force	特定のファイル操作 (ファイルの上書き、空でないディレクトリの削除など) によって、エラーが発生します。 Force プロパティを使用すると、このようなエラーがオーバーライドされます。既定値は `$false` です。
リンク	シンボリックリンクの目的の動作を指定します。シンボリックリンクに従い、処理の対象をリンクのターゲットにするには、このプロパティを follow に設定します。たとえば、リンクではなくファイルをコピーします。処理の対象をリンクにするには、このプロパティを manage に設定します。たとえば、リンク自体をコピーします。シンボリックリンクを無視するには、このプロパティを ignore に設定します。
グループ	ファイルまたはディレクトリのアクセス許可を与えるグループの名前。
モード	8 進数またはシンボリック表記で、リソースに必要なアクセス許可を指定します。たとえば、777 または rwxrwxrwx です。シンボリック表記を使用する場合は、ディレクトリまたはファイルを示す最初の文字を指定しないでください。
所有者	ファイルまたはディレクトリを所有するグループの名前。

共通プロパティ

プロパティ	説明
DependsOn	このリソースを構成する前に、他のリソースの構成を実行する必要があることを示します。たとえば、最初に実行するリソース構成スクリプトブロックの ID が ResourceName で、そのタイプが ResourceType である場合、このプロパティを使用する構文は `DependsOn = "[ResourceType]ResourceName"` になります。
Ensure	ファイルが存在するかどうかを決定します。ファイルが存在することを保証するには、このプロパティを Present に設定します。ファイルが存在しないことを保証するには、Absent に設定します。既定値は Present です。

追加情報

Linux と Windows の既定では、テキストファイルで異なる改行文字を使用して、これにより、nxFile を使用して Linux コンピューターで一部のファイルを構成すると、予期しない結果が発生することがあります。予期しない改行文字によって引き起こされる問題を回避しながら Linux ファイルのコンテンツを管理する複数の方法があります。

リモートソース (http、https、または ftp) からファイルをコピーします。

目的のコンテンツを含むファイルを Linux 上で作成し、構成するノードにアクセスできる Web サーバーまたは FTP サーバーでステージングします。ファイルへの Web または FTP の URL で、nxFile リソースの SourcePath プロパティを定義します。
```
Import-DSCResource -ModuleName nx

Node $Node
{
   nxFile resolvConf
   {
      SourcePath = "http://10.185.85.11/conf/resolv.conf"
      DestinationPath = "/etc/resolv.conf"
      Mode = "644"
      Type = "file"
   }
}
```

Linux 改行文字を使用する $OFS プロパティの設定後に、Get-Content を使用して PowerShell スクリプトのファイルコンテンツを読み取ります。

Import-DSCResource -ModuleName nx

Node $Node
{
   $OFS = "`n"
   $Contents = Get-Content C:\temp\resolv.conf

   nxFile resolvConf
   {
      DestinationPath = "/etc/resolv.conf"
      Mode = "644"
      Type = "file"
      Contents = "$Contents"
   }
}

PowerShell 関数を使用して、Linux 改行文字で Windows の改行を置き換えます。

Function LinuxString($inputStr){
   $outputStr = $inputStr.Replace("`r`n","`n")
   $outputStr += "`n"
   Return $outputStr
}

Import-DSCResource -ModuleName nx

Node $Node
{
   $Contents = @'
search contoso.com
domain contoso.com
nameserver 10.185.85.11
'@
    $Contents = LinuxString $Contents

   nxFile resolvConf
   {
      DestinationPath = "/etc/resolv.conf"
      Mode = "644"
      Type = "file"
      Contents = $Contents
   }
}

例

次の例では、ディレクトリ /opt/mydir が存在し、指定されたコンテンツを持つファイルがこのディレクトリが存在するようにしています。

Import-DSCResource -ModuleName nx

Node $node {
    nxFile DirectoryExample
    {
        Ensure = "Present"
        DestinationPath = "/opt/mydir"
        Type = "Directory"
    }

    nxFile FileExample
    {
        Ensure = "Present"
        Destinationpath = "/opt/mydir/myfile"
        Contents=@"
#!/bin/bash`necho "hello world"`n
"@
        Mode = "755"
        DependsOn = "[nxFile]DirectoryExample"
    }
}

Linux 用 DSC の nxFile リソース

構文

Properties

共通プロパティ

追加情報

例

フィードバック

その他のリソース