EN-US/RapidID-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RIDGroupLogic</command:name> <command:verb>Get</command:verb> <command:noun>RIDGroupLogic</command:noun> <maml:description> <maml:para>Gets RapidID include logic from attribute "idautoGroupIncludeFilter".</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-RIDGroupLogic cmdlet gets a specified group object's idautoGroupIncludeFilter attribute</maml:para> <maml:para>The Identity parameter specifies the Active Directory group to get. You can identify a group by its name. You can also set the parameter to a group object variable, such as $<localGroupObject> or pass a group object through the pipeline to the Identity parameter.</maml:para> <maml:para>This cmdlet retrieves only the value of idautoGroupIncludeFilter from group object properties.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RIDGroupLogic</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>- Fully qualified domain name (FQDN)</maml:para> <maml:para>- NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>- Fully qualified directory server name</maml:para> <maml:para>- NetBIOS name</maml:para> <maml:para>- Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>- By using Server value from objects passed through the pipeline.</maml:para> <maml:para>- By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>- Fully qualified domain name (FQDN)</maml:para> <maml:para>- NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>- Fully qualified directory server name</maml:para> <maml:para>- NetBIOS name</maml:para> <maml:para>- Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>- By using Server value from objects passed through the pipeline.</maml:para> <maml:para>- By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-RIDGroupLogic -Identity testGroupWithLogic name idautoGroupIncludeFilter ---- ------------------------ testGroupWithLogic (&(employeetype=staff)) PS C:\> Get-RIDGroupLogic -Identity testGroupWithOutLogic name idautoGroupIncludeFilter ---- ------------------------ testGroupWithLogic</dev:code> <dev:remarks> <maml:para>This command displays idautoGroupIncludeFilter property value for group name testGroupWithLogic and testGroupWithOutLogic.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-RIDGroupLogic -Identity testGroupWithLogic name idautoGroupIncludeFilter ---- ------------------------ testGroupWithLogic (&(employeetype=staff)) PS C:\> Get-RIDGroupLogic -Identity testGroupWithOutLogic name idautoGroupIncludeFilter ---- ------------------------ testGroupWithOutLogic</dev:code> <dev:remarks> <maml:para>This command displays idautoGroupIncludeFilter property value for group name testGroupWithLogic and testGroupWithOutLogic as recorded on Domain Controller DC01.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Get-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Set-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Remove-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Test-RIDGroupLogic.md</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-RIDGroupLogic</command:name> <command:verb>Remove</command:verb> <command:noun>RIDGroupLogic</command:noun> <maml:description> <maml:para>Removes idautoGroupIncludeFilter value from an Active Directory group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-RIDGroupLogic cmdlet removes the set value of an Active Directory group's idautoGroupIncludeFilter.</maml:para> <maml:para>The Identity parameter specifies the Active Directory group to get. You can identify a group by its name. You can also set the parameter to a group object variable, such as $<localGroupObject> or pass a group object through the pipeline to the Identity parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RIDGroupLogic</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-RIDGroupLogic -Identity TestGroup</dev:code> <dev:remarks> <maml:para>This command removes idautoGroupIncludeFilter property value for group name testGroup.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Remove-RIDGroupLogic -Identity TestGroup -Server DC01</dev:code> <dev:remarks> <maml:para>This command removes idautoGroupIncludeFilter property value for group name testGroup on Domain Controller DC01.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Remove-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Get-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Remove-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Test-RIDGroupLogic.md</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RIDGroupLogic</command:name> <command:verb>Set</command:verb> <command:noun>RIDGroupLogic</command:noun> <maml:description> <maml:para>Modifies an Active Directory group logic.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-RIDGroupLogic cmdlet modifies the properties of an Active Directory group's idautoGroupIncludeFilter.</maml:para> <maml:para>The Identity parameter specifies the Active Directory group to get. You can identify a group by its name. You can also set the parameter to a group object variable, such as $<localGroupObject> or pass a group object through the pipeline to the Identity parameter.</maml:para> <maml:para>Logic parameter must be provided as a LDAP filter. If already set must be removed prior to attempting to set.</maml:para> <maml:para>Example: (&(attribute=value))</maml:para> <maml:para>Reference ["Active Directory: LDAP Syntax Filters" (https://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx)] for additional information on LDAP Filters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RIDGroupLogic</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Logic</maml:name> <maml:Description> <maml:para>LDAP Filter logic desired to manage members.</maml:para> <maml:para>Reference ["Active Directory: LDAP Syntax Filters" (https://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx)] for additional information on LDAP Filters.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Logic</maml:name> <maml:Description> <maml:para>LDAP Filter logic desired to manage members.</maml:para> <maml:para>Reference ["Active Directory: LDAP Syntax Filters" (https://social.technet.microsoft.com/wiki/contents/articles/5392.active-directory-ldap-syntax-filters.aspx)] for additional information on LDAP Filters.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-RIDGroupLogic -Identity TestGroup -Logic "(&(employeetype=staff))"</dev:code> <dev:remarks> <maml:para>This command sets idautoGroupIncludeFilter property value to (&(employeetype=staff)) for group name testGroup.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-RIDGroupLogic -Identity TestGroup -Logic "(&(employeetype=staff))" -Server DC01</dev:code> <dev:remarks> <maml:para>This command sets idautoGroupIncludeFilter property value to (&(employeetype=staff)) for group name testGroup on Domain Controller DC01.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Set-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Get-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Set-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Test-RIDGroupLogic.md</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-RIDGroupLogic</command:name> <command:verb>Test</command:verb> <command:noun>RIDGroupLogic</command:noun> <maml:description> <maml:para>Check if group already has include logic set. Return True/False.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Test-RIDGroupLogic cmdlet views a specified group object's idautoGroupIncludeFilter attribute.</maml:para> <maml:para>The Identity parameter specifies the Active Directory group to get. You can identify a group by its name. You can also set the parameter to a group object variable, such as $<localGroupObject> or pass a group object through the pipeline to the Identity parameter.</maml:para> <maml:para>This cmdlet returns either True if idautoGroupIncludeFilter from group object properties is populated or False if idautoGroupIncludeFilter from group object properties is empty or NULL.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-RIDGroupLogic</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>Specifies an Active Directory group object by providing SAM account name (sAMAccountName). The identifier in parentheses is the LDAP display name for the attribute.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Server</maml:name> <maml:Description> <maml:para>Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.</maml:para> <maml:para>Domain name values:</maml:para> <maml:para>--Fully qualified domain name (FQDN)</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para></maml:para> <maml:para>Directory server values:</maml:para> <maml:para>--Fully qualified directory server name</maml:para> <maml:para>--NetBIOS name</maml:para> <maml:para>--Fully qualified directory server name and port</maml:para> <maml:para></maml:para> <maml:para>The default value for the Server parameter is determined by one of the following methods in the order that they are listed:</maml:para> <maml:para>--By using Server value from objects passed through the pipeline.</maml:para> <maml:para>--By using the domain of the computer running PowerShell.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Test-RIDGroupLogic -Identity testGroupWithLogic true PS C:\> Test-RIDGroupLogic -Identity testGroupWithOutLogic false</dev:code> <dev:remarks> <maml:para>This command displays idautoGroupIncludeFilter property value for group name testGroupWithLogic and testGroupWithOutLogic.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Test-RIDGroupLogic -Identity testGroupWithLogic -Server DC01 true PS C:\> Test-RIDGroupLogic -Identity testGroupWithOutLogic -Server DC01 false</dev:code> <dev:remarks> <maml:para>This command displays idautoGroupIncludeFilter property value for group name testGroupWithLogic and testGroupWithOutLogic as recorded on Domain Controller DC01.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Test-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Get-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Set-RIDGroupLogic.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RIDGroupLogic</maml:linkText> <maml:uri>https://github.com/clee1107/RapidID/blob/master/docs/Remove-RIDGroupLogic.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |