en-US/DataONTAP.C.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcAggr</command:name> <maml:description> <maml:para>Add disks to the specified aggregate.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcAggr</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add disks to the specified aggregate. The disks to add are specified in the same way as for New-NcAggr. By the time the API returns, the disk(s) may not yet be completely added. Use Get-NcAggr to query the aggregate status to determine when it has finished growing due to the added disk(s). When the Upgrade64BitMode input is provided to this API, the API produces a set of results in the background. These results are not available as output from Add-NcAggr. Use the Get-NcAggr and Get-NcVol cmdlets to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcAggr</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskCount</maml:name> <maml:description> <maml:para>Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the DiskSize argument is specified. Either the DiskCount or Disks argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ChecksumStyle</maml:name> <maml:description> <maml:para>Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the Disks parameter. The possible values: "advanced_zoned" - advanced_zoned checksum (azcs) "block" - block. By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskSize</maml:name> <maml:description> <maml:para>The individual disk size in bytes. Disks that are within approximately 20% of the specified size will be selected. If the DiskSize argument is not specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raid group are selected first, then smaller disks, and finally larger disks. This DiskSize option is ignored if a specific list of disks is specified through the Disks parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >UInt64</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disks to use: ATA, BSAS, EATA, FCAL, FSAS, LUN, SAS, SATA, SCSI, XATA, XSAS, or SSD. This option is required when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcAggr</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskCount</maml:name> <maml:description> <maml:para>Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the DiskSize argument is specified. Either the DiskCount or Disks argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ChecksumStyle</maml:name> <maml:description> <maml:para>Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the Disks parameter. The possible values: "advanced_zoned" - advanced_zoned checksum (azcs) "block" - block. By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskSize</maml:name> <maml:description> <maml:para>The individual disk size in bytes. Disks that are within approximately 20% of the specified size will be selected. If the DiskSize argument is not specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raid group are selected first, then smaller disks, and finally larger disks. This DiskSize option is ignored if a specific list of disks is specified through the Disks parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >UInt64</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskClass</maml:name> <maml:description> <maml:para>Class of disks to use. Possible values are: "capacity" - Capacity-oriented, near-line disk types. Includes disk types FSAS, BSAS and ATA. "performance" - Performance-oriented, enterprise class disk types. Includes disk types FCAL and SAS. "archive" - Archive class SATA disks in multi-disk carrier storage shelves. Includes disk type MSATA. "solid-state" - Solid-state drives. Includes disk type SSD. "array" - Logical storage devices backed by storage arrays and used by Data ONTAP as disks. Includes disk type LUN. "virtual"- Virtual disks that are formatted and managed by VMware ESX. Includes disk type VMDISK. Disks are grouped into classes based on their performance characteristics. Disks belonging to the same class are compatible for use in the same aggregate. When this option is used, all disks belonging to the specified disk class are considered eligible for selection. One of either "DiskType, "ActualDiskType" or "DiskClass" is required to be used when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcAggr</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskCount</maml:name> <maml:description> <maml:para>Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the DiskSize argument is specified. Either the DiskCount or Disks argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ChecksumStyle</maml:name> <maml:description> <maml:para>Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the Disks parameter. The possible values: "advanced_zoned" - advanced_zoned checksum (azcs) "block" - block. By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DiskSize</maml:name> <maml:description> <maml:para>The individual disk size in bytes. Disks that are within approximately 20% of the specified size will be selected. If the DiskSize argument is not specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raid group are selected first, then smaller disks, and finally larger disks. This DiskSize option is ignored if a specific list of disks is specified through the Disks parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >UInt64</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ActualDiskType</maml:name> <maml:description> <maml:para>Actual disk type of disks to use, possible values are: ATA, BSAS, FCAL, FSAS, LUN, MSATA, SAS, SSD, or VMDISK. When this option is used, only disks of the specified type will be selected for use in the aggregate. One of either "DiskType, "ActualDiskType" or "DiskClass" is required to be used when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcAggr</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Disks</maml:name> <maml:description> <maml:para>Specific list of disks to add to the aggregate. Either the Disks or DiskCount argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Object[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowSameCarrier</maml:name> <maml:description> <maml:para>If specified, allow placing two disks from one carrier in one RAID group. Using two disks from one carrier that houses multiple disks in one RAID group is not desirable. If that happens, Data ONTAP initiates a series of disk copy operations to correct that situation. Sometimes, selection of available spare disks makes it impossible to avoid placing two disks from one carrier in one RAID group.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcAggr</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Name of the shared storage pool from which the capacity will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AllocationUnits</maml:name> <maml:description> <maml:para>The spare capacity in terms of number of allocation units to be added to a given aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the aggregate to which the disks will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskCount</maml:name> <maml:description> <maml:para>Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the DiskSize argument is specified. Either the DiskCount or Disks argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ChecksumStyle</maml:name> <maml:description> <maml:para>Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the Disks parameter. The possible values: "advanced_zoned" - advanced_zoned checksum (azcs) "block" - block. By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSize</maml:name> <maml:description> <maml:para>The individual disk size in bytes. Disks that are within approximately 20% of the specified size will be selected. If the DiskSize argument is not specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raid group are selected first, then smaller disks, and finally larger disks. This DiskSize option is ignored if a specific list of disks is specified through the Disks parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type> <maml:name>UInt64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupSelectionMode</maml:name> <maml:description> <maml:para>Specifies how Data ONTAP adds the specified disks to RAID groups. Legitimate values are "last", "one", "new" or "all". GroupSelectionMode is an optional argument, and the behavior when it is not used is selected by value of RaidGroup. If RaidGroup is used, the behavior is the same as for GroupSelectionMode "one". If RaidGroup is not used, the behavior is the same as for GroupSelectionMode "last". The RaidGroup option must be used with GroupSelectionMode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by RaidGroup option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceSparePool</maml:name> <maml:description> <maml:para>Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Upgrade64BitMode</maml:name> <maml:description> <maml:para>Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, Add-NcAggr produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained via the Get-NcAggr and Get-NcVol cmdlets. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, Add-NcAggr upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows Add-NcAggr to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskType</maml:name> <maml:description> <maml:para>Type of disks to use: ATA, BSAS, EATA, FCAL, FSAS, LUN, SAS, SATA, SCSI, XATA, XSAS, or SSD. This option is required when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowMixedRpm</maml:name> <maml:description> <maml:para>If specified, disks in an aggregate are not required to have the same RPM.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IgnorePoolChecks</maml:name> <maml:description> <maml:para>If specified, disks in a plex are not required to come from the same spare pool.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PreCheck</maml:name> <maml:description> <maml:para>If specified, only check for the warnings without actually adding the disks.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ForceCacheSize</maml:name> <maml:description> <maml:para>If specified, force the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Warning: If specified, the administrator is responsible to ensure that the total limit will not be exceeded.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CacheRaidType</maml:name> <maml:description> <maml:para>Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp. If not specified, the default value is the raid-type of the aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CacheRaidGroupSize</maml:name> <maml:description> <maml:para>The RAID group size of the new SSD RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OutputJob</maml:name> <maml:description> <maml:para>If specified, output the job responsible for creating the aggregate. Progress can be tracked using the job cmdlets. This parameter is available in ONTAP 8.3 and later.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Simulate</maml:name> <maml:description> <maml:para>Simulates the addition of disks to the given aggregate or UUID of the aggregate. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RaidGroup</maml:name> <maml:description> <maml:para>Specifies the RAID group (for example rg0) to which the indicated disks are to be added. By default, the controller fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskClass</maml:name> <maml:description> <maml:para>Class of disks to use. Possible values are: "capacity" - Capacity-oriented, near-line disk types. Includes disk types FSAS, BSAS and ATA. "performance" - Performance-oriented, enterprise class disk types. Includes disk types FCAL and SAS. "archive" - Archive class SATA disks in multi-disk carrier storage shelves. Includes disk type MSATA. "solid-state" - Solid-state drives. Includes disk type SSD. "array" - Logical storage devices backed by storage arrays and used by Data ONTAP as disks. Includes disk type LUN. "virtual"- Virtual disks that are formatted and managed by VMware ESX. Includes disk type VMDISK. Disks are grouped into classes based on their performance characteristics. Disks belonging to the same class are compatible for use in the same aggregate. When this option is used, all disks belonging to the specified disk class are considered eligible for selection. One of either "DiskType, "ActualDiskType" or "DiskClass" is required to be used when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActualDiskType</maml:name> <maml:description> <maml:para>Actual disk type of disks to use, possible values are: ATA, BSAS, FCAL, FSAS, LUN, MSATA, SAS, SSD, or VMDISK. When this option is used, only disks of the specified type will be selected for use in the aggregate. One of either "DiskType, "ActualDiskType" or "DiskClass" is required to be used when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Disks</maml:name> <maml:description> <maml:para>Specific list of disks to add to the aggregate. Either the Disks or DiskCount argument must be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllowSameCarrier</maml:name> <maml:description> <maml:para>If specified, allow placing two disks from one carrier in one RAID group. Using two disks from one carrier that houses multiple disks in one RAID group is not desirable. If that happens, Data ONTAP initiates a series of disk copy operations to correct that situation. Sometimes, selection of available spare disks makes it impossible to avoid placing two disks from one carrier in one RAID group.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StoragePool</maml:name> <maml:description> <maml:para>Name of the shared storage pool from which the capacity will be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllocationUnits</maml:name> <maml:description> <maml:para>The spare capacity in terms of number of allocation units to be added to a given aggregate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Aggr.AggrAttributes</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: aggr API: aggr-add Family: cluster</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcAggr aggr2 -DiskCount 3</dev:code> <dev:remarks> <maml:para>Add three disks to aggregate 'aggr2'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Name State TotalSize Used Available Disks RaidType RaidSize Volumes ---- ----- --------- ---- --------- ----- -------- -------- ------- aggr2 online 717.1 GB 0% 717.1 GB 8 raid_dp,normal 16 0 </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-NcAggr</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcAggrObjectStore</command:name> <maml:description> <maml:para>Attach an object store to an aggregate</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcAggrObjectStore</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Attach an object store to an aggregate</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcAggrObjectStore</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Aggregate</maml:name> <maml:description> <maml:para>Name of the Aggregate</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>ObjectStoreName</maml:name> <maml:description> <maml:para>Object Store Configuration Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "3" > <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Validate But Do Not Attach</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>AllowFlexgroup</maml:name> <maml:description> <maml:para>Allow FlexGroup Constituents in the Aggregate This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Aggregate</maml:name> <maml:description> <maml:para>Name of the Aggregate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ObjectStoreName</maml:name> <maml:description> <maml:para>Object Store Configuration Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CheckOnly</maml:name> <maml:description> <maml:para>Validate But Do Not Attach</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AllowFlexgroup</maml:name> <maml:description> <maml:para>Allow FlexGroup Constituents in the Aggregate This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: aggr API: aggr-object-store-attach Family: cluster</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsHomeDirectorySearchPath</command:name> <maml:description> <maml:para>Add a path to the list of paths that will be searched to find a CIFS user's home directory.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsHomeDirectorySearchPath</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add a path to the list of paths that will be searched to find a CIFS user's home directory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsHomeDirectorySearchPath</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Path</maml:name> <maml:description> <maml:para>The file system path that will be searched for finding a CIFS user's home directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file system path that will be searched for finding a CIFS user's home directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsHomeDirectorySearchPath</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-home-directory-search-path-add Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsHomeDirectorySearchPath -Path /usr/frank</dev:code> <dev:remarks> <maml:para>Add path /usr/frank to the paths that will be searched to find a CIFS user's home directory</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Position Path -------- ---- 1 /usr/frank </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCifsHomeDirectorySearchPath</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NcCifsHomeDirectorySearchPath</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsHomeDirectorySearchPath</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsLocalGroupMember</command:name> <maml:description> <maml:para>Add local users or Active Directory users or groups to a local group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsLocalGroupMember</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add local users or Active Directory users or groups to a local group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsLocalGroupMember</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the local group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>Member</maml:name> <maml:description> <maml:para>Names of Users or Active Directory groups to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the local group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Member</maml:name> <maml:description> <maml:para>Names of Users or Active Directory groups to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsLocalGroupMembers</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-local-group-members-add-members Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsLocalGroupMember -Name 'PowerShell Users' -Member bort</dev:code> <dev:remarks> <maml:para>Add bort to 'PowerShell Users'.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>GroupName Member NcController Vserver --------- ------ ------------ ------- BEAM02\PowerShell Users BEAM02\bort 10.63.165.62 beam01 </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCifsLocalGroupMember</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsLocalGroupMember</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsPreferredDomainController</command:name> <maml:description> <maml:para>Add to a list of preferred domain controllers</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsPreferredDomainController</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add to a list of preferred domain controllers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsPreferredDomainController</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Domain</maml:name> <maml:description> <maml:para>The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>DomainControllers</maml:name> <maml:description> <maml:para>List of preferred domain controllers to add to the list for this Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>SkipConfigValidation</maml:name> <maml:description> <maml:para>Skip Configuration Validation</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>DomainControllers</maml:name> <maml:description> <maml:para>List of preferred domain controllers to add to the list for this Domain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SkipConfigValidation</maml:name> <maml:description> <maml:para>Skip Configuration Validation</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsDomainPreferredDc</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-domain-preferred-dc-add Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsPreferredDomainController -Domain TEST -DomainControllers 10.10.10.5</dev:code> <dev:remarks> <maml:para>Add the domain controller with address 10.10.10.5 to the list of preferred domain controllers for domain TEST.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Domain PreferredDc ------ ----------- TEST {10.10.10.5} </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCifsPreferredDomainController</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsPreferredDomainController</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsPrivilege</command:name> <maml:description> <maml:para>Add privileges to a local or Active Directory user or group.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsPrivilege</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add privileges to a local or Active Directory user or group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsPrivilege</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>User or Group Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>Privilege</maml:name> <maml:description> <maml:para>CIFS privileges to add. Possible values: "setcbprivilege" - Act as part of the operating system, "sebackupprivilege" - Back up files and directories, overriding any ACLs, "serestoreprivilege" - Restore files and directories, overriding any ACLs, "setakeownershipprivilege" - Take ownership of files or other objects, "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>User or Group Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Privilege</maml:name> <maml:description> <maml:para>CIFS privileges to add. Possible values: "setcbprivilege" - Act as part of the operating system, "sebackupprivilege" - Back up files and directories, overriding any ACLs, "serestoreprivilege" - Restore files and directories, overriding any ACLs, "setakeownershipprivilege" - Take ownership of files or other objects, "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsPrivilege</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-privilege-add-privilege Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsPrivilege -Name bort -Privilege sebackupprivilege</dev:code> <dev:remarks> <maml:para>Add sebackupprivilege privilege to user bort.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Privileges UserOrGroupName Vserver ---------- --------------- ------- {sebackupprivilege} BEAM02\bort beam01 </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-NcCifsPrivilege</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-NcCifsPrivilege</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NcCifsPrivilege</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsServer</command:name> <maml:description> <maml:para>Configure and setup CIFS services on a Vserver.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsServer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Configure and setup CIFS services on a Vserver.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsServer</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The NetBIOS name to give the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Domain</maml:name> <maml:description> <maml:para>The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultSite</maml:name> <maml:description> <maml:para>The default site used by LIFs that do not have a site membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "3" > <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>The username of the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "4" > <maml:name>AdminPassword</maml:name> <maml:description> <maml:para>The password for the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>If this is set and a machine account with the same name as specified in 'Name' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdministrativeStatus</maml:name> <maml:description> <maml:para>CIFS Server Administrative Status. Possible values: "down", "up"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Comment</maml:name> <maml:description> <maml:para>CIFS server description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetbiosAlias</maml:name> <maml:description> <maml:para>One or more NetBIOS aliases for the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies if the CIFS service is administratively enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Svm</maml:name> <maml:description> <maml:para>Specifies Svm. To create object use New-Object DataONTAP.C.Types.Cifs.Svm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Svm</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdDomain</maml:name> <maml:description> <maml:para>Specifies Domain. To create object use New-Object DataONTAP.C.Types.Cifs.AdDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.AdDomain</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Netbios</maml:name> <maml:description> <maml:para>Specifies Netbios. To create object use New-Object DataONTAP.C.Types.Cifs.Netbios.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Netbios</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcCifsServer</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The NetBIOS name to give the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>Domain</maml:name> <maml:description> <maml:para>The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultSite</maml:name> <maml:description> <maml:para>The default site used by LIFs that do not have a site membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "3" > <maml:name>AdminCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the credentials for the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>If this is set and a machine account with the same name as specified in 'Name' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdministrativeStatus</maml:name> <maml:description> <maml:para>CIFS Server Administrative Status. Possible values: "down", "up"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Comment</maml:name> <maml:description> <maml:para>CIFS server description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetbiosAlias</maml:name> <maml:description> <maml:para>One or more NetBIOS aliases for the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies if the CIFS service is administratively enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Svm</maml:name> <maml:description> <maml:para>Specifies Svm. To create object use New-Object DataONTAP.C.Types.Cifs.Svm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Svm</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdDomain</maml:name> <maml:description> <maml:para>Specifies Domain. To create object use New-Object DataONTAP.C.Types.Cifs.AdDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.AdDomain</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Netbios</maml:name> <maml:description> <maml:para>Specifies Netbios. To create object use New-Object DataONTAP.C.Types.Cifs.Netbios.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Netbios</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcCifsServer</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The NetBIOS name to give the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultSite</maml:name> <maml:description> <maml:para>The default site used by LIFs that do not have a site membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>If this is set and a machine account with the same name as specified in 'Name' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdministrativeStatus</maml:name> <maml:description> <maml:para>CIFS Server Administrative Status. Possible values: "down", "up"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Comment</maml:name> <maml:description> <maml:para>CIFS server description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetbiosAlias</maml:name> <maml:description> <maml:para>One or more NetBIOS aliases for the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Workgroup</maml:name> <maml:description> <maml:para>The name of the workgroup this CIFS server belongs to. This parameter is available in ONTAP 9.0 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies if the CIFS service is administratively enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Svm</maml:name> <maml:description> <maml:para>Specifies Svm. To create object use New-Object DataONTAP.C.Types.Cifs.Svm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Svm</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdDomain</maml:name> <maml:description> <maml:para>Specifies Domain. To create object use New-Object DataONTAP.C.Types.Cifs.AdDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.AdDomain</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Netbios</maml:name> <maml:description> <maml:para>Specifies Netbios. To create object use New-Object DataONTAP.C.Types.Cifs.Netbios.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Netbios</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcCifsServer</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The NetBIOS name to give the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DefaultSite</maml:name> <maml:description> <maml:para>The default site used by LIFs that do not have a site membership.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Force</maml:name> <maml:description> <maml:para>If this is set and a machine account with the same name as specified in 'Name' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdministrativeStatus</maml:name> <maml:description> <maml:para>CIFS Server Administrative Status. Possible values: "down", "up"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Comment</maml:name> <maml:description> <maml:para>CIFS server description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>NetbiosAlias</maml:name> <maml:description> <maml:para>One or more NetBIOS aliases for the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Realm</maml:name> <maml:description> <maml:para>The Kerberos realm this CIFS server belongs to. This parameter is available in ONTAP 9.2 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>KeytabUri</maml:name> <maml:description> <maml:para>Kerberos Keytab File URI This parameter is available in ONTAP 9.2 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies if the CIFS service is administratively enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Svm</maml:name> <maml:description> <maml:para>Specifies Svm. To create object use New-Object DataONTAP.C.Types.Cifs.Svm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Svm</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdDomain</maml:name> <maml:description> <maml:para>Specifies Domain. To create object use New-Object DataONTAP.C.Types.Cifs.AdDomain.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.AdDomain</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Netbios</maml:name> <maml:description> <maml:para>Specifies Netbios. To create object use New-Object DataONTAP.C.Types.Cifs.Netbios.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Netbios</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The NetBIOS name to give the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Domain</maml:name> <maml:description> <maml:para>The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrganizationalUnit</maml:name> <maml:description> <maml:para>The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DefaultSite</maml:name> <maml:description> <maml:para>The default site used by LIFs that do not have a site membership. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AdminUsername</maml:name> <maml:description> <maml:para>The username of the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>AdminPassword</maml:name> <maml:description> <maml:para>The password for the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If this is set and a machine account with the same name as specified in 'Name' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false. This parameter is supported with Ontapi only.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdministrativeStatus</maml:name> <maml:description> <maml:para>CIFS Server Administrative Status. Possible values: "down", "up"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>CIFS server description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>NetbiosAlias</maml:name> <maml:description> <maml:para>One or more NetBIOS aliases for the CIFS server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Enabled</maml:name> <maml:description> <maml:para>Specifies if the CIFS service is administratively enabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Svm</maml:name> <maml:description> <maml:para>Specifies Svm. To create object use New-Object DataONTAP.C.Types.Cifs.Svm. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Svm</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.Svm</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AdDomain</maml:name> <maml:description> <maml:para>Specifies Domain. To create object use New-Object DataONTAP.C.Types.Cifs.AdDomain. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.AdDomain</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.AdDomain</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Netbios</maml:name> <maml:description> <maml:para>Specifies Netbios. To create object use New-Object DataONTAP.C.Types.Cifs.Netbios. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Netbios</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.Netbios</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Options</maml:name> <maml:description> <maml:para>Specifies Options. To create object use New-Object DataONTAP.C.Types.Cifs.Options. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Options</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.Options</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Security</maml:name> <maml:description> <maml:para>Specifies Security. To create object use New-Object DataONTAP.C.Types.Cifs.Security. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.Cifs.Security</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.Security</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>AdminCredential</maml:name> <maml:description> <maml:para>PSCredential object containing the credentials for the account used to add this CIFS server to the Active Directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Workgroup</maml:name> <maml:description> <maml:para>The name of the workgroup this CIFS server belongs to. This parameter is available in ONTAP 9.0 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Realm</maml:name> <maml:description> <maml:para>The Kerberos realm this CIFS server belongs to. This parameter is available in ONTAP 9.2 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>KeytabUri</maml:name> <maml:description> <maml:para>Kerberos Keytab File URI This parameter is available in ONTAP 9.2 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsServerConfig</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-server-create Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsServer -Name CIFS01 -Domain TESTDOMAIN -AdminUsername Administrator -AdminPassword p@ssword</dev:code> <dev:remarks> <maml:para>Creates the CIFS server CIFS01 and adds it to the domain TESTDOMAIN.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>CifsServer AuthStyle Domain OrganizationalUnit ---------- --------- ------ ------------------ CIFS01 domain TESTDOMAIN </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-NcCifsServer</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsServer</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NcCifsServer</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsShadowCopyFile</command:name> <maml:description> <maml:para>Add a list of files to shadow copy in a particular share.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsShadowCopyFile</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add a list of files to shadow copy in a particular share.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsShadowCopyFile</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Id</maml:name> <maml:description> <maml:para>The universally-unique identifier of the client's shadow copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>File</maml:name> <maml:description> <maml:para>The list of files to shadow copy in the share. The path is in UTF8 and uses forward slash as directory separator. The path is relative to the root of the share.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The universally-unique identifier of the client's shadow copy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2"> <maml:name>File</maml:name> <maml:description> <maml:para>The list of files to shadow copy in the share. The path is in UTF8 and uses forward slash as directory separator. The path is relative to the root of the share.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsShadowCopyAddFilesResult</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-shadowcopy-add-files Family: cluster, vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsShare</command:name> <maml:description> <maml:para>Creates a new CIFS share rooted at the specified path.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsShare</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Creates a new CIFS share rooted at the specified path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsShare</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>Path</maml:name> <maml:description> <maml:para>The file system path that is shared through this CIFS share.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ShareProperties</maml:name> <maml:description> <maml:para>The list of properties for this CIFS share. Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share. "browsable" - This specifies that the share can be browsed by Windows clients. "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients. "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share. "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface. "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SymlinkProperties</maml:name> <maml:description> <maml:para>This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: "enable", "hide", "read_only"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>FileUmask</maml:name> <maml:description> <maml:para>The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>DirUmask</maml:name> <maml:description> <maml:para>The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Comment</maml:name> <maml:description> <maml:para>This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OfflineFilesMode</maml:name> <maml:description> <maml:para>Mode of the offline file for the CIFS share. The default value is manual. Possible values: "none" - Clients are not permitted to cache files for offline access. "manual" - Clients may cache files that are explicitly selected by the user for offline use. "documents" - Clients may automatically cache files that are used by the user for offline access. "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AttributeCacheTtl</maml:name> <maml:description> <maml:para>The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>VscanProfile</maml:name> <maml:description> <maml:para>Profile-set of file-ops to which Vscan On-Access scanning is applicable. The default value is standard. Possible values: 'no_scan' - Virus scans are never triggered for accesses to this share, 'standard' - Virus scans can be triggered by open, close, and rename operations, 'strict' - Virus scans can be triggered by open, read, close, and rename operations 'writes_only' - Virus scans can be triggered only when a file that has been modified is closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>MaxConnectionsPerShare</maml:name> <maml:description> <maml:para>The maximum number of simultaneous connections to the share.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int64</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ForceGroupForCreate</maml:name> <maml:description> <maml:para>Specifies the group that all files that CIFS users create in the share must belong to (also called the "force-group"). The "force-group" must be a predefined group in the UNIX group database. This setting has no effect unless the security style of the volume is UNIX or mixed security style. You can disable this option by passing a null string "".</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>DisablePathValidation</maml:name> <maml:description> <maml:para>If specified, the CIFS Share Path validation will be disabled.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OfflineFiles</maml:name> <maml:description> <maml:para>Offline Files. The default value is none. The supported values are:: 'none' - Clients are not permitted to cache files for offline access, 'manual' - Clients may cache files that are explicitly selected by the user for offline access, 'documents' - Clients may automatically cache files that are used by the user for offline access, 'programs' - Clients may automatically cache files that are used by the user for offline access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>HomeDirectory</maml:name> <maml:description> <maml:para>Specifies whether or not the share is a home directory share, where the share and path names are dynamic. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Oplocks</maml:name> <maml:description> <maml:para>Specify whether opportunistic locks are enabled on this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>AccessBasedEnumeration</maml:name> <maml:description> <maml:para>If enabled, all folders inside this share are visible to a user based on that individual user access right; prevents the display of folders or other shared resources that the user does not have access to. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ChangeNotify</maml:name> <maml:description> <maml:para>Specifies whether CIFS clients can request for change notifications for directories on this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Encryption</maml:name> <maml:description> <maml:para>Specifies that SMB encryption must be used when accessing this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ShowSnapshot</maml:name> <maml:description> <maml:para>Specifies whether or not the Snapshot copies can be viewed and traversed by clients. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ContinuouslyAvailable</maml:name> <maml:description> <maml:para>Specifies whether or not the clients connecting to this share can open files in a persistent manner. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NamespaceCaching</maml:name> <maml:description> <maml:para>Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration results returned by the CIFS servers. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NoStrictSecurity</maml:name> <maml:description> <maml:para>Specifies whether or not CIFS clients can follow a unix symlinks outside the share boundaries. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>UnixSymlink</maml:name> <maml:description> <maml:para>Controls the access of UNIX symbolic links to CIFS clients. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ShowPreviousVersion </maml:name> <maml:description> <maml:para>Specifies that the previous version can be viewed and restored from the client. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >bool?</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Browsable </maml:name> <maml:description> <maml:para>Specifies whether or not the Windows clients can browse the share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >bool?</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file system path that is shared through this CIFS share.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ShareProperties</maml:name> <maml:description> <maml:para>The list of properties for this CIFS share. Possible values: "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share. "browsable" - This specifies that the share can be browsed by Windows clients. "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients. "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share. "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface. "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SymlinkProperties</maml:name> <maml:description> <maml:para>This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: "enable", "hide", "read_only"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FileUmask</maml:name> <maml:description> <maml:para>The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DirUmask</maml:name> <maml:description> <maml:para>The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Comment</maml:name> <maml:description> <maml:para>This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OfflineFilesMode</maml:name> <maml:description> <maml:para>Mode of the offline file for the CIFS share. The default value is manual. Possible values: "none" - Clients are not permitted to cache files for offline access. "manual" - Clients may cache files that are explicitly selected by the user for offline use. "documents" - Clients may automatically cache files that are used by the user for offline access. "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributeCacheTtl</maml:name> <maml:description> <maml:para>The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>VscanProfile</maml:name> <maml:description> <maml:para>Profile-set of file-ops to which Vscan On-Access scanning is applicable. The default value is standard. Possible values: 'no_scan' - Virus scans are never triggered for accesses to this share, 'standard' - Virus scans can be triggered by open, close, and rename operations, 'strict' - Virus scans can be triggered by open, read, close, and rename operations 'writes_only' - Virus scans can be triggered only when a file that has been modified is closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>MaxConnectionsPerShare</maml:name> <maml:description> <maml:para>The maximum number of simultaneous connections to the share. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ForceGroupForCreate</maml:name> <maml:description> <maml:para>Specifies the group that all files that CIFS users create in the share must belong to (also called the "force-group"). The "force-group" must be a predefined group in the UNIX group database. This setting has no effect unless the security style of the volume is UNIX or mixed security style. You can disable this option by passing a null string "".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DisablePathValidation</maml:name> <maml:description> <maml:para>If specified, the CIFS Share Path validation will be disabled.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>OfflineFiles</maml:name> <maml:description> <maml:para>Offline Files. The default value is none. The supported values are:: 'none' - Clients are not permitted to cache files for offline access, 'manual' - Clients may cache files that are explicitly selected by the user for offline access, 'documents' - Clients may automatically cache files that are used by the user for offline access, 'programs' - Clients may automatically cache files that are used by the user for offline access.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>HomeDirectory</maml:name> <maml:description> <maml:para>Specifies whether or not the share is a home directory share, where the share and path names are dynamic. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Oplocks</maml:name> <maml:description> <maml:para>Specify whether opportunistic locks are enabled on this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>AccessBasedEnumeration</maml:name> <maml:description> <maml:para>If enabled, all folders inside this share are visible to a user based on that individual user access right; prevents the display of folders or other shared resources that the user does not have access to. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ChangeNotify</maml:name> <maml:description> <maml:para>Specifies whether CIFS clients can request for change notifications for directories on this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Encryption</maml:name> <maml:description> <maml:para>Specifies that SMB encryption must be used when accessing this share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ShowSnapshot</maml:name> <maml:description> <maml:para>Specifies whether or not the Snapshot copies can be viewed and traversed by clients. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>ContinuouslyAvailable</maml:name> <maml:description> <maml:para>Specifies whether or not the clients connecting to this share can open files in a persistent manner. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NamespaceCaching</maml:name> <maml:description> <maml:para>Specifies whether or not the SMB clients connecting to this share can cache the directory enumeration results returned by the CIFS servers. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NoStrictSecurity</maml:name> <maml:description> <maml:para>Specifies whether or not CIFS clients can follow a unix symlinks outside the share boundaries. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>UnixSymlink</maml:name> <maml:description> <maml:para>Controls the access of UNIX symbolic links to CIFS clients. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Browsable</maml:name> <maml:description> <maml:para>Specifies whether or not the Windows clients can browse the share. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ShowPreviousVersion</maml:name> <maml:description> <maml:para>Specifies that the previous version can be viewed and restored from the client. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsShare</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-share-create Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsShare -Name cifsvol1 -Path /cifsvol1</dev:code> <dev:remarks> <maml:para>Add a CIFS share called cifsvol1 which shares path /cifsvol1.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>CifsServer ShareName Path Comment ---------- --------- ---- ------- CIFS01 cifsvol1 /cifsvol1 </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-NcCifsShare</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsShare</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NcCifsShare</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsShareAcl</command:name> <maml:description> <maml:para>Add permissions for a user or group for a defined CIFS share.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsShareAcl</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add permissions for a user or group for a defined CIFS share.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsShareAcl</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Share</maml:name> <maml:description> <maml:para>The CIFS share for which the permissions are defined.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>UserOrGroup</maml:name> <maml:description> <maml:para>The user or group name for which the permissions are listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "3" > <maml:name>Permission</maml:name> <maml:description> <maml:para>The access rights that the user or group has on the defined CIFS share. Possible values: "no_access", "read", "change", "full_control"</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>UserGroupType</maml:name> <maml:description> <maml:para>The type of user for which ACL is configured. Default value is windows. Possible values: 'windows' - Windows User or Group 'unix_user' - Unix User 'unix_group' - Unix Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Winsid</maml:name> <maml:description> <maml:para>The Windows SID for the user or group for which the permission is defined. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Share</maml:name> <maml:description> <maml:para>The CIFS share for which the permissions are defined.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>UserOrGroup</maml:name> <maml:description> <maml:para>The user or group name for which the permissions are listed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Permission</maml:name> <maml:description> <maml:para>The access rights that the user or group has on the defined CIFS share. Possible values: "no_access", "read", "change", "full_control"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserGroupType</maml:name> <maml:description> <maml:para>The type of user for which ACL is configured. Default value is windows. Possible values: 'windows' - Windows User or Group 'unix_user' - Unix User 'unix_group' - Unix Group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Winsid</maml:name> <maml:description> <maml:para>The Windows SID for the user or group for which the permission is defined. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsShareAccessControl</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-share-access-control-create Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsShareAcl -Share cifsvol1 -UserOrGroup Users -Permission read</dev:code> <dev:remarks> <maml:para>Add "read" permissions for users in the "Users" group on CIFS share cifsvol1.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Share UserOrGroup Permission ----- ----------- ---------- cifsvol1 Users read </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-NcCifsShareAcl</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NcCifsShareAcl</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsShareAcl</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsSymlink</command:name> <maml:description> <maml:para>Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsSymlink</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'CifsServer', 'ShareName' and 'CifsPath' fields.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsSymlink</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>UnixPath</maml:name> <maml:description> <maml:para>This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>ShareName</maml:name> <maml:description> <maml:para>This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "3" > <maml:name>CifsPath</maml:name> <maml:description> <maml:para>This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>CifsServer</maml:name> <maml:description> <maml:para>This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Locality</maml:name> <maml:description> <maml:para>This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: "local" - Share On This VServer "widelink" - Share On Another CIFS Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>HomeDirectory</maml:name> <maml:description> <maml:para></maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>UnixPath</maml:name> <maml:description> <maml:para>This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ShareName</maml:name> <maml:description> <maml:para>This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>CifsPath</maml:name> <maml:description> <maml:para>This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CifsServer</maml:name> <maml:description> <maml:para>This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Locality</maml:name> <maml:description> <maml:para>This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: "local" - Share On This VServer "widelink" - Share On Another CIFS Server</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>HomeDirectory</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsSymlink</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-symlink-create Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsSymlink -UnixPath /usr/user/ -ShareName cifsvol1 -CifsPath /cifsvol1/user/</dev:code> <dev:remarks> <maml:para>Add a CIFS symlink with unix path /usr/user/ and CIFS path /cifsvol1/user/</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>CifsServer ShareName UnixPath CifsPath Locality ---------- --------- -------- -------- -------- CIFS01 cifsvol1 /usr/user/ /cifsvol1/user/ local </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCifsSymlink</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsSymlink</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NcCifsSymlink</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCifsTrustedDomain</command:name> <maml:description> <maml:para>Add to the list of trusted domains for name-mapping search.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCifsTrustedDomain</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add to the list of trusted domains for name-mapping search.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCifsTrustedDomain</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>TrustedDomain</maml:name> <maml:description> <maml:para>Trusted domains to add to the search list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>TrustedDomain</maml:name> <maml:description> <maml:para>Trusted domains to add to the search list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Cifs.CifsDomainNameMappingSearch</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cifs API: cifs-domain-name-mapping-search-add Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCifsTrustedDomain -TrustedDomain rtprre.testdomain</dev:code> <dev:remarks> <maml:para>Add the rtprre.testdomain domain to the trusted domains list for the current Vserver.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>TrustedDomains Vserver -------------- ------- {RTPRRE.TESTDOMAIN} beam_vsim01 </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCifsTrustedDomain</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCifsTrustedDomain</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-NcCifsTrustedDomain</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCloneDeletionExtension</command:name> <maml:description> <maml:para>Add new supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCloneDeletionExtension</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Add new supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCloneDeletionExtension</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Volume</maml:name> <maml:description> <maml:para>The volume name</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "2" > <maml:name>Extension</maml:name> <maml:description> <maml:para>List supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Volume</maml:name> <maml:description> <maml:para>The volume name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Extension</maml:name> <maml:description> <maml:para>List supported file extensions for file(s) and lun(s) on the specified volume to be deleted with clone-delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VserverContext</maml:name> <maml:description> <maml:para>Vserver to which to direct this command. If the currently connected controller (as embodied by an NcController object) represents a cluster, there are multiple means to address commands to one of its vservers. Either set the Vserver field on the NcController object to direct all subsequent commands to that vserver, or supply the VserverContext parameter to an individual cmdlet. Only cmdlets which may be invoked on vservers offer the VserverContext parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.Types.Clone.CloneDeletionInfo</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: clone API: clone-deletion-add-extension Family: vserver</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCloneDeletionExtension -Volume move_test -Extension cln</dev:code> <dev:remarks> <maml:para>Add file extension cln to the list of autodelete extensions on volume move_test</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Vserver Volume MinimumSiz Extensions e ------- ------ ---------- ---------- pstk_san move_test 0 vmdk,vhd,vhdx,vswp,cln, </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-NcCloneDeletion</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCloneDeletionExtension</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcCluster</command:name> <maml:description> <maml:para>Start the process of joining this node to a cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcCluster</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Start the process of joining this node to a cluster. Join can be done by Cluster IP Address or Cluster Name. Only one join operation is supported at a time. Use Get-NcClusterCreateProgress to track the status of the operation. Please note this cmdlet works when connected to a node in pre-cluster mode. After cluster creation, you'll need to re-connect to the cluster in order to ensure other cmdlets run as expected.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcCluster</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of the cluster to join.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcCluster</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>ClusterAddress</maml:name> <maml:description> <maml:para>IP Address of a Cluster-Interconnect Interface, from a node already in the Cluster. This will be used to identify which cluster to join.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ClusterName</maml:name> <maml:description> <maml:para>Name of the cluster to join.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ClusterAddress</maml:name> <maml:description> <maml:para>IP Address of a Cluster-Interconnect Interface, from a node already in the Cluster. This will be used to identify which cluster to join.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cluster API: cluster-join Family: cluster</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcCluster -ClusterAddress 172.31.4.158</dev:code> <dev:remarks> <maml:para>Adds the currently connected node to a cluster which has cluster interconnect LIF 172.31.4.158</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>PS > </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcClusterNode</command:name> <maml:description> <maml:para>This cmdlet can be used to add new nodes to cluster.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcClusterNode</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet can be used to discover and add new nodes to cluster. You may provide either NodeCount or NodeIp. To run this cmdlet you must be connected to the cluster. If you are connected to the node (in pre-cluster mode), please use Add-NcCluster to perform cluster join. A job will be spawned to operate on the cluster and the job id will be returned. The progress of the job can be tracked using the Get-NcJob cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcClusterNode</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>NodeIp</maml:name> <maml:description> <maml:para>Use this option to add a specific node based on it's cluster IP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeNames</maml:name> <maml:description> <maml:para>Use this option to specify the names to use for the nodes added using the cluster-ips argument. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Retry</maml:name> <maml:description> <maml:para>Retry a failed cluster add-node operation. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeUuids</maml:name> <maml:description> <maml:para>List of Node UUIDs This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcClusterNode</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>NodeCount</maml:name> <maml:description> <maml:para>Use this option to discover and add new nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int64</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeNames</maml:name> <maml:description> <maml:para>Use this option to specify the names to use for the nodes added using the cluster-ips argument. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Retry</maml:name> <maml:description> <maml:para>Retry a failed cluster add-node operation. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeUuids</maml:name> <maml:description> <maml:para>List of Node UUIDs This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcClusterNode</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>ClusterIps</maml:name> <maml:description> <maml:para>Use this option to add a set of nodes based on their cluster IP addresses. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeNames</maml:name> <maml:description> <maml:para>Use this option to specify the names to use for the nodes added using the cluster-ips argument. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Retry</maml:name> <maml:description> <maml:para>Retry a failed cluster add-node operation. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>NodeUuids</maml:name> <maml:description> <maml:para>List of Node UUIDs This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>NodeIp</maml:name> <maml:description> <maml:para>Use this option to add a specific node based on it's cluster IP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NodeNames</maml:name> <maml:description> <maml:para>Use this option to specify the names to use for the nodes added using the cluster-ips argument. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Retry</maml:name> <maml:description> <maml:para>Retry a failed cluster add-node operation. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NodeUuids</maml:name> <maml:description> <maml:para>List of Node UUIDs This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">NcController[]</command:parameterValue> <dev:type> <maml:name>NcController[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>NodeCount</maml:name> <maml:description> <maml:para>Use this option to discover and add new nodes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>ClusterIps</maml:name> <maml:description> <maml:para>Use this option to add a set of nodes based on their cluster IP addresses. This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DataONTAP.C.PowerShell.SDK.Cmdlets.JobStartResult</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para>Category: cluster API: cluster-add-node Family: cluster</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-NcClusterNode -NodeCount 2</dev:code> <dev:remarks> <maml:para>Searches for 2 nodes in pre-cluster phase in the current network and adds them to this cluster.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>NcController : 10.63.4.209 ErrorCode : ErrorMessage : JobId : 24 JobVserver : Status : in_progress </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-NcClusterNode</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-NcClusterNode</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-NcCluster</maml:linkText> <maml:uri/> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-NcCluster</maml:linkText> <maml:uri/> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Generated by Help Cmdlet Editor--> <command:details> <command:name>Add-NcClusterPeer</command:name> <maml:description> <maml:para>Create a cluster peer relationship.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>NcClusterPeer</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Create a cluster peer relationship.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-NcClusterPeer</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Address</maml:name> <maml:description> <maml:para>The remote intercluster addresses and hostnames of the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout for operations in the peer cluster in seconds. Default: 15</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Password</maml:name> <maml:description> <maml:para>The password required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AddressFamily</maml:name> <maml:description> <maml:para>The address family (IPv4/IPv6) of the peer cluster connection. Possible values: ipv4, ipv6</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>OfferExpiration</maml:name> <maml:description> <maml:para>The expiration time of the authentication offer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Passphrase</maml:name> <maml:description> <maml:para>The arbitrary passphrase that matches the one given to the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>IpspaceName</maml:name> <maml:description> <maml:para>IPspace in which the LIFs for this relationship are to be found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Encrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Possible values: "never" - Never Encrypt, "as_possible" - Encrypt Where Possible, "always" - Require Encryption Default value is "never". This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>LocalName</maml:name> <maml:description> <maml:para>Local name for remote cluster. Default: Remote cluster name. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>DarkEncrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Default: Never: never encrypt This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>GeneratePassphrase</maml:name> <maml:description> <maml:para>Use System-Generated passphrase This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>InitialAllowedVserverPeers</maml:name> <maml:description> <maml:para>Vservers allowed for auto peering This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>EncryptionProtocolProposed</maml:name> <maml:description> <maml:para>Encryption protocol to be used for inter-cluster communication. Default: tls-psk when authentication is used, otherwise none</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AuthStatusAdmin</maml:name> <maml:description> <maml:para>Specifies Authentication In-Use. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies Name. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LocalNetwork</maml:name> <maml:description> <maml:para>Specifies local_network. To create object use New-Object DataONTAP.C.Types.ClusterPeer.LocalNetwork. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.ClusterPeer.LocalNetwork</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PeerApplications</maml:name> <maml:description> <maml:para>Specifies PeerApplications. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-NcClusterPeer</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "1" > <maml:name>Address</maml:name> <maml:description> <maml:para>The remote intercluster addresses and hostnames of the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout for operations in the peer cluster in seconds. Default: 15</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Credential</maml:name> <maml:description> <maml:para>The credentials required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PSCredential</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AddressFamily</maml:name> <maml:description> <maml:para>The address family (IPv4/IPv6) of the peer cluster connection. Possible values: ipv4, ipv6</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>OfferExpiration</maml:name> <maml:description> <maml:para>The expiration time of the authentication offer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Passphrase</maml:name> <maml:description> <maml:para>The arbitrary passphrase that matches the one given to the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>IpspaceName</maml:name> <maml:description> <maml:para>IPspace in which the LIFs for this relationship are to be found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>Encrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Possible values: "never" - Never Encrypt, "as_possible" - Encrypt Where Possible, "always" - Require Encryption Default value is "never". This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>LocalName</maml:name> <maml:description> <maml:para>Local name for remote cluster. Default: Remote cluster name. This parameter is available in ONTAP 8.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>DarkEncrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Default: Never: never encrypt This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>GeneratePassphrase</maml:name> <maml:description> <maml:para>Use System-Generated passphrase This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>InitialAllowedVserverPeers</maml:name> <maml:description> <maml:para>Vservers allowed for auto peering This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByPropertyName)" position = "named" > <maml:name>EncryptionProtocolProposed</maml:name> <maml:description> <maml:para>Encryption protocol to be used for inter-cluster communication. Default: tls-psk when authentication is used, otherwise none</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue, ByPropertyName)" position = "named" > <maml:name>Controller</maml:name> <maml:description> <maml:para>A clustered Data ONTAP controller to receive this cmdlet, as embodied by an NcController object. This parameter is returned by the Connect-NcController cmdlet. If not specified, the value in the global variable CurrentNcController is used. In the latter case, if CurrentNcController contains a collection of NcController objects, this cmdlet is invoked on each controller in succession.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >NcController[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationAction</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ActionPreference</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InformationVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PipelineVariable</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ZapiRetryCount</maml:name> <maml:description> <maml:para>The number of times to retry commands that return with errors that may succeed after a retry</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Address</maml:name> <maml:description> <maml:para>The remote intercluster addresses and hostnames of the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout for operations in the peer cluster in seconds. Default: 15. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>15</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name required to authenticate with the peer cluster. This value is only used at peer creation time and not stored. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password required to authenticate with the peer cluster. This value is only used at peer creation time and not stored. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AddressFamily</maml:name> <maml:description> <maml:para>The address family (IPv4/IPv6) of the peer cluster connection. Possible values: ipv4, ipv6. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OfferExpiration</maml:name> <maml:description> <maml:para>The expiration time of the authentication offer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Passphrase</maml:name> <maml:description> <maml:para>The arbitrary passphrase that matches the one given to the peer cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>IpspaceName</maml:name> <maml:description> <maml:para>IPspace in which the LIFs for this relationship are to be found.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Encrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Possible values: "never" - Never Encrypt, "as_possible" - Encrypt Where Possible, "always" - Require Encryption Default value is "never". This parameter is available in ONTAP 8.4 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LocalName</maml:name> <maml:description> <maml:para>Local name for remote cluster. Default: Remote cluster name. This parameter is available in ONTAP 8.4 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DarkEncrypt</maml:name> <maml:description> <maml:para>Guidance for use of encryption. Default: Never: never encrypt This parameter is available in ONTAP 9.4 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GeneratePassphrase</maml:name> <maml:description> <maml:para>Use System-Generated passphrase This parameter is available in ONTAP 9.4 and later.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>InitialAllowedVserverPeers</maml:name> <maml:description> <maml:para>Vservers allowed for auto peering This parameter is available in ONTAP 9.4 and later. This parameter is supported with Ontapi only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EncryptionProtocolProposed</maml:name> <maml:description> <maml:para>Encryption protocol to be used for inter-cluster communication. Default: tls-psk when authentication is used, otherwise none</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>AuthStatusAdmin</maml:name> <maml:description> <maml:para>Specifies Authentication In-Use. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies Name. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>LocalNetwork</maml:name> <maml:description> <maml:para>Specifies local_network. To create object use New-Object DataONTAP.C.Types.ClusterPeer.LocalNetwork. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DataONTAP.C.Types.ClusterPeer.LocalNetwork</command:parameterValue> <dev:type> <maml:name>DataONTAP.C.Types.ClusterPeer.LocalNetwork</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>PeerApplications</maml:name> <maml:description> <maml:para>Specifies PeerApplications. This parameter is supported with Rest only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" p |