NtObjectManager.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>NtObjectManager</name> </assembly> <members> <member name="T:NtObjectManager.TaskLogonType"> <summary> The type of logon used for the task. </summary> </member> <member name="F:NtObjectManager.TaskLogonType.None"> <summary> No logon type. </summary> </member> <member name="F:NtObjectManager.TaskLogonType.Group"> <summary> Group activation. </summary> </member> <member name="F:NtObjectManager.TaskLogonType.User"> <summary> User activation. </summary> </member> <member name="F:NtObjectManager.TaskLogonType.S4U"> <summary> Uses Services for User. </summary> </member> <member name="F:NtObjectManager.TaskLogonType.ServiceAccount"> <summary> Service account. </summary> </member> <member name="T:NtObjectManager.TaskRunLevel"> <summary> The task run level to use. </summary> </member> <member name="F:NtObjectManager.TaskRunLevel.Limited"> <summary> Normal limited user. </summary> </member> <member name="F:NtObjectManager.TaskRunLevel.Highest"> <summary> Highed run level available. </summary> </member> <member name="T:NtObjectManager.TaskActionType"> <summary> The type of action the task performs when run. </summary> </member> <member name="F:NtObjectManager.TaskActionType.None"> <summary> None or unknown. </summary> </member> <member name="F:NtObjectManager.TaskActionType.Execute"> <summary> Execute a process. </summary> </member> <member name="F:NtObjectManager.TaskActionType.ComObject"> <summary> Load a COM object. </summary> </member> <member name="F:NtObjectManager.TaskActionType.SendEmail"> <summary> Send an email. </summary> </member> <member name="F:NtObjectManager.TaskActionType.ShowMessage"> <summary> Show a message. </summary> </member> <member name="T:NtObjectManager.TaskRunFlags"> <summary> Flags for running a task. </summary> </member> <member name="F:NtObjectManager.TaskRunFlags.None"> <summary> None </summary> </member> <member name="F:NtObjectManager.TaskRunFlags.AsSelf"> <summary> Run as user calling Run. </summary> </member> <member name="F:NtObjectManager.TaskRunFlags.IgnoreConstrains"> <summary> Ignore task constraints. </summary> </member> <member name="F:NtObjectManager.TaskRunFlags.UseSessionId"> <summary> Use the session ID for the terminal session. </summary> </member> <member name="F:NtObjectManager.TaskRunFlags.UserSid"> <summary> Run using a SID. </summary> </member> <member name="T:NtObjectManager.ScheduledTaskAction"> <summary> Class to represent a scheduled task action. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAction.ActionType"> <summary> Type of action. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAction.Action"> <summary> Summary of what will be invoked. </summary> </member> <member name="M:NtObjectManager.ScheduledTaskAction.ToString"> <summary> Overridden ToString. </summary> <returns>The action as a string.</returns> </member> <member name="T:NtObjectManager.ScheduledTaskAccessCheckResult"> <summary> <para type="description">Access check result for a scheduled task.</para> </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.Enabled"> <summary> Whether the task is enabled. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.Hidden"> <summary> Whether the task is hidden. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.AllowDemandStart"> <summary> Whether the task can be started on demand. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.Xml"> <summary> The full XML registration for the task. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.LogonType"> <summary> The logon type of the task. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.RunLevel"> <summary> The run level of the type. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.Principal"> <summary> The principal of the type. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.Actions"> <summary> List of the actions. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.ActionCount"> <summary> Number of actions. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.DefaultActionType"> <summary> The default type of action. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.DefaultAction"> <summary> The default action to be invoked. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.TaskName"> <summary> Get the task name. </summary> </member> <member name="P:NtObjectManager.ScheduledTaskAccessCheckResult.TaskPath"> <summary> Get the task path. </summary> </member> <member name="M:NtObjectManager.ScheduledTaskAccessCheckResult.Run(System.String[])"> <summary> Try and run the last with optional arguments. </summary> <param name="args">Optional arguments.</param> </member> <member name="M:NtObjectManager.ScheduledTaskAccessCheckResult.RunEx(NtObjectManager.TaskRunFlags,System.Int32,System.String,System.String[])"> <summary> Try and run the last with optional arguments. </summary> <param name="args">Optional arguments.</param> <param name="flags">Flags for the run operation.</param> <param name="session_id">Optional session ID (Needs UseSessionId flag).</param> <param name="user">Optional user name or SID.</param> </member> <member name="T:NtObjectManager.TaskCheckMode"> <summary> <para type="description">Limit access check to specific types of task information.</para> </summary> </member> <member name="F:NtObjectManager.TaskCheckMode.TasksOnly"> <summary> Check tasks only. </summary> </member> <member name="F:NtObjectManager.TaskCheckMode.FoldersOnly"> <summary> Check folders only. </summary> </member> <member name="F:NtObjectManager.TaskCheckMode.All"> <summary> Check both folders and tasks. </summary> </member> <member name="T:NtObjectManager.GetAccessibleScheduledTaskCmdlet"> <summary> <para type="synopsis">Get a list of scheduled tasks openable by a specified token.</para> <para type="description">This cmdlet checks all scheduled tasks and tries to determine if one or more specified tokens can open them. If no tokens are specified then the current process token is used.</para> </summary> <remarks>For best results this command should be run as an administrator.</remarks> <example> <code>Get-AccessibleScheduledTask</code> <para>Check all accessible scheduled tasks for the current process token.</para> </example> <example> <code>Get-AccessibleScheduledTask -Executable</code> <para>Check all executable scheduled tasks for the current process token.</para> </example> <example> <code>Get-AccessibleScheduledTask -ProcessIds 1234,5678</code> <para>>Check all accessible scheduled tasks for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleScheduledTask -Tokens $token -AccessRights GenericWrite</code> <para>Get all scheduled tasks which can be written by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleScheduledTaskCmdlet.CheckMode"> <summary> <para type="description">Limit access check to specific types of files.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleScheduledTaskCmdlet.DirectoryAccessRights"> <summary> <para type="description">Specify a set of directory access rights which a folder must at least be accessible for to count as an access.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleScheduledTaskCmdlet.Executable"> <summary> <para type="description">Shortcut to specify that we're querying for executable tasks.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleScheduledTaskCmdlet.Writable"> <summary> <para type="description">Shortcut to specify that we're querying for writable tasks or directories.</para> </summary> </member> <member name="T:NtObjectManager.ConnectNtAlpcClient"> <summary> <para type="synopsis">Connects to an ALPC server by path.</para> <para type="description">This cmdlet connects to an existing NT ALPC server. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter (if running on Win8+).</para> </summary> <example> <code>$obj = Connect-NtAlpcClient "\RPC Control\ABC"</code> <para>Connect to an ALPC object with an absolute path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.ConnectNtAlpcClient.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.ConnectNtAlpcClient.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.ConnectNtAlpcClient.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.HandleObjectAttributes"> <summary> <para type="description">Optional object attributes for the handle.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.PortAttributes"> <summary> <para type="description">Optional port attributes.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.Flags"> <summary> <para type="description">Flags for sending the initial message.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.RequiredServerSid"> <summary> <para type="description">Optional SID to verify the server's identity.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.ServerSecurityRequirements"> <summary> <para type="description">Optional security descriptor to verify the server's identity.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.ConnectionMessage"> <summary> <para type="description">Optional initial connection message.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.OutMessageAttributes"> <summary> <para type="description">Optional outbound message attributes.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.InMessageAttributes"> <summary> <para type="description">Optional inbound message attributes.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcClient.Timeout"> <summary> <para type="description">Optional connection timeout.</para> </summary> </member> <member name="T:NtObjectManager.ConnectNtAlpcServer"> <summary> <para type="synopsis">Accepts a connection on an ALPC server port.</para> <para type="description">This cmdlet accepts a connection on an ALPC server port and returns the new server port to communicate with the client.</para> </summary> <example> <code>$conn = Connect-NtAlpcServer -Port $port -ConnectionMessage $msg</code> <para>Accepts a connection on an ALPC server port.</para> </example> <example> <code>$conn = Connect-NtAlpcServer -Port $port -ConnectionMessage $msg -Reject</code> <para>Reject a connection on an ALPC server port.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.ConnectNtAlpcServer.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.Port"> <summary> <para type="description">The server port to accept the connection.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.ConnectionMessage"> <summary> <para type="description">Initial connection message from the initial receive call.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.PortContext"> <summary> <para type="description">Optional context value for the new port.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.PortAttributes"> <summary> <para type="description">Optional port attributes.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.Flags"> <summary> <para type="description">Flags for sending the initial message.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.ConnectionAttributes"> <summary> <para type="description">Optional connection message attributes.</para> </summary> </member> <member name="P:NtObjectManager.ConnectNtAlpcServer.Reject"> <summary> <para type="description">Specify to reject the client connection.</para> </summary> </member> <member name="T:NtObjectManager.NewNtAlpcServer"> <summary> <para type="synopsis">Creates a new ALPC server by path.</para> <para type="description">This cmdlet creates a new NT ALPC server. The absolute path to the object in the NT object manager name space must be specified. </para> </summary> <example> <code>$obj = New-NtAlpcServer "\RPC Control\ABC"</code> <para>Create a new ALPC server with an absolute path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtAlpcServer.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtAlpcServer.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcServer.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="P:NtObjectManager.NewNtAlpcServer.PortAttributes"> <summary> <para type="description">Optional port attributes.</para> </summary> </member> <member name="T:NtObjectManager.NewNtAlpcPortAttributes"> <summary> <para type="synopsis">Creates a new ALPC port attributes structure.</para> <para type="description">This cmdlet creates a new ALPC port attributes structure based on single components.</para> </summary> <example> <code>$attr = New-NtAlpcPortAttributes</code> <para>Create a new ALPC port attributes structure with default values.</para> </example> <example> <code>$attr = New-NtAlpcPortAttributes -Flags None</code> <para>Create a new ALPC port attributes structure.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.Flags"> <summary> <para type="description">Port attributes flags</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.ImpersonationLevel"> <summary> <para type="description">Security Quality of Service impersonation level.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.ContextTrackingMode"> <summary> <para type="description">Security Quality of Service context tracking mode.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.EffectiveOnly"> <summary> <para type="description">Security Quality of Service effective only.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MaxMessageLength"> <summary> <para type="description">Maximum message length.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MemoryBandwidth"> <summary> <para type="description">Memory bandwidth.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MaxPoolUsage"> <summary> <para type="description">Max pool usage.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MaxSectionSize"> <summary> <para type="description">Max section size.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MaxViewSize"> <summary> <para type="description">Max view size.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.MaxTotalSectionSize"> <summary> <para type="description">Max total section size.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortAttributes.DupObjectTypes"> <summary> <para type="description">Duplicate object types..</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcPortAttributes.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtAlpcPortAttributes.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcMessage"> <summary> <para type="synopsis">Creates a new ALPC message.</para> <para type="description">This cmdlet creates a new ALPC message based on a byte array or an length initializer. You can also specify a text encoding which allows you to use the DataString property.</para> </summary> <example> <code>$msg = New-NtAlpcMessage -Bytes @(0, 1, 2, 3)</code> <para>Create a new message from a byte array.</para> </example> <example> <code>$msg = New-NtAlpcMessage -Bytes @(0, 1, 2, 3) -AllocatedDataLength 1000</code> <para>Create a new message from a byte array with an allocated length of 1000 bytes.</para> </example> <example> <code>$msg = New-NtAlpcMessage -AllocatedDataLength 1000</code> <para>Create a new message with an allocated length of 1000 bytes.</para> </example> <example> <code>$msg = New-NtAlpcMessage -AllocatedDataLength 1000 -Encoding UTF8</code> <para>Create a new message with an allocated length of 1000 bytes and the message encoding is UTF8.</para> </example> <example> <code>$msg = New-NtAlpcMessage -String "Hello World!"</code> <para>Create a new message from a unicode string.</para> </example> <example> <code>$msg = New-NtAlpcMessage -String "Hello World!" -Encoding UTF8</code> <para>Create a new message from a UTF8 string.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcMessage.Bytes"> <summary> <para type="description">Create the message from a byte array.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcMessage.String"> <summary> <para type="description">Create the message from a string.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcMessage.Encoding"> <summary> <para type="description">Get or set the text encoding for this message.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcMessage.AllocatedDataLength"> <summary> <para type="description">Specify the message with allocated length.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcMessage.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtAlpcMessage.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.SendNtAlpcMessage"> <summary> <para type="synopsis">Sends a message on an ALPC port and optionally receives one as well.</para> <para type="description">This cmdlet sends a message on an ALPC port and optionally receives ones.</para> </summary> <example> <code>Send-NtAlpcMessage -Port $port -Message $msg</code> <para>Send a message on a port.</para> </example> <example> <code>$recv_msg = Send-NtAlpcMessage -Port $port -Message $msg -ReceiveLength 80 -Flags SyncMessage</code> <para>Send a message on a port and waits for a message of up to 80 bytes.</para> </example> <example> <code>Send-NtAlpcMessage -Port $port -Bytes @(0, 1, 2, 3)</code> <para>Send a message on a port from a byte array.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.Port"> <summary> <para type="description">Specify the port to send the message on.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.Bytes"> <summary> <para type="description">Specify message to send from a byte array.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.Message"> <summary> <para type="description">Specify message to send.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.Flags"> <summary> <para type="description">Specify send flags.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.SendAttributes"> <summary> <para type="description">Specify send attributes.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.TimeoutMs"> <summary> <para type="description">Specify optional timeout in MS.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.ReceiveLength"> <summary> <para type="description">Specify optional length of message to receive.</para> </summary> </member> <member name="P:NtObjectManager.SendNtAlpcMessage.ReceiveAttributes"> <summary> <para type="description">Specify receive attributes.</para> </summary> </member> <member name="M:NtObjectManager.SendNtAlpcMessage.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.SendNtAlpcMessage.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.ReceiveNtAlpcMessage"> <summary> <para type="synopsis">Receives a message on an ALPC port.</para> <para type="description">This cmdlet receives a message on an ALPC port.</para> </summary> <example> <code>$recv_msg = Receive-NtAlpcMessage -Port $port -ReceiveLength 80</code> <para>Receive a message of up to 80 bytes.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.ReceiveNtAlpcMessage.Port"> <summary> <para type="description">Specify the port to send the message on.</para> </summary> </member> <member name="P:NtObjectManager.ReceiveNtAlpcMessage.Flags"> <summary> <para type="description">Specify send flags.</para> </summary> </member> <member name="P:NtObjectManager.ReceiveNtAlpcMessage.TimeoutMs"> <summary> <para type="description">Specify optional timeout in MS.</para> </summary> </member> <member name="P:NtObjectManager.ReceiveNtAlpcMessage.ReceiveLength"> <summary> <para type="description">Specify the maximum length of message to receive.</para> </summary> </member> <member name="P:NtObjectManager.ReceiveNtAlpcMessage.ReceiveAttributes"> <summary> <para type="description">Specify receive attributes.</para> </summary> </member> <member name="M:NtObjectManager.ReceiveNtAlpcMessage.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.ReceiveNtAlpcMessage.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcReceiveAttributes"> <summary> <para type="synopsis">Creates a new receive attributes buffer.</para> <para type="description">This cmdlet creates a new receive attributes buffer for the specified set of attributes. This defaults to all known attributes.</para> </summary> <example> <code>$attrs = New-NtAlpcReceiveAttributes</code> <para>Create a new receive attributes buffer with space for all known attributes.</para> </example> <example> <code>$attrs = New-NtAlpcReceiveAttributes -Attributes View, Context</code> <para>Create a new receive attributes buffer with space for only View and Context attributes.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcReceiveAttributes.Attributes"> <summary> <para type="description">Specify the list of attributes for the receive buffer.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcReceiveAttributes.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtAlpcReceiveAttributes.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcSendAttributes"> <summary> <para type="synopsis">Creates a new send attributes buffer.</para> <para type="description">This cmdlet creates a new send attributes buffer. The buffer can be initialized with a list of attributes or by specifying specific values.</para> </summary> <example> <code>$attrs = New-NtAlpcSendAttributes</code> <para>Create a new empty send attributes buffer.</para> </example> <example> <code>$attrs = New-NtAlpcSendAttributes -Attributes $view, $handle</code> <para>Create a new send attributes buffer with view and handle attribute objects.</para> </example> <example> <code>$attrs = New-NtAlpcSendAttributes -Object $proc</code> <para>Create a new send attributes buffer with a handle attribute from a process handle.</para> </example> <example> <code>$attrs = New-NtAlpcSendAttributes -WorkOnBehalfOf</code> <para>Create a new send attributes buffer with a Work on Behalf of attribute.</para> </example> <example> <code>$attrs = New-NtAlpcSendAttributes -DataView $dataview</code> <para>Create a new send attributes buffer with data view.</para> </example> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.Attributes"> <summary> <para type="description">Specify the list of attributes for the send buffer.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.Object"> <summary> <para type="description">Create a handle attribute from a list of objects.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.Handle"> <summary> <para type="description">Create a handle attribute from a list of handle entries.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.WorkOnBehalfOf"> <summary> <para type="description">Add a Work on Behalf of attribute.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.DataView"> <summary> <para type="description">Add a data view attribute.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.SecurityQualityOfService"> <summary> <para type="description">Automatically create a security context attribute with a specified security quality of service.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSendAttributes.SecurityContext"> <summary> <para type="description">Specify a security context attribute.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcSendAttributes.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtAlpcSendAttributes.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcPortSection"> <summary> <para type="synopsis">Creates a new port section from a port.</para> <para type="description">This cmdlet creates a new port section with a specified size and flags for a port. You can then write to buffer and pass it as a view attribute.</para> </summary> <example> <code>$s = New-NtAlpcPortSection -Size 10000</code> <para>Create a new port section of size 10000.</para> </example> <example> <code>$s = New-NtAlpcPortSection -Size 10000 -Secure</code> <para>Create a new secure port section of size 10000.</para> </example> <example> <code>$s = New-NtAlpcPortSection -Section $sect</code> <para>>Create a new port section backed by an existing section.</para> </example> <example> <code>$s = New-NtAlpcPortSection -Section $sect -Size 10000</code> <para>>Create a new port section backed by an existing section with an explicit view size.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcPortSection.Port"> <summary> <para type="description">Specify the port to create the port section from.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortSection.Size"> <summary> <para type="description">Specify the size of the port section. This will be rounded up to the nearest allocation boundary.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortSection.Secure"> <summary> <para type="description">Create a secure section.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcPortSection.Section"> <summary> <para type="description">Specify an existing section to back the port section.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcPortSection.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcDataView"> <summary> <para type="synopsis">Creates a new data view from a port section.</para> <para type="description">This cmdlet creates a new data view from a port section specified size and flags.</para> </summary> <example> <code>$s = New-NtAlpcDataView -Section $section -Size 10000</code> <para>Create a new data view with size 10000.</para> </example> <example> <code>$s = New-NtAlpcDataView -Size 10000 -Flags Secure</code> <para>Create a new secure data view section of size 10000.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcDataView.Section"> <summary> <para type="description">Specify the port to create the port section from.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcDataView.Size"> <summary> <para type="description">Specify the size of the data view. This will be rounded up to the nearest allocation boundary.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcDataView.Flags"> <summary> <para type="description">Specify data view attribute flags.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcDataView.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.NewNtAlpcSecurityContext"> <summary> <para type="synopsis">Creates a new ALPC security context.</para> <para type="description">This cmdlet creates a new ALPC security context pages of a specified security quality of serice..</para> </summary> <example> <code>$ctx = New-NtAlpcSecurityContext -Port $port</code> <para>Create a new security context with default values.</para> </example> <example> <code>$ctx = New-NtAlpcSecurityContext -Port $port -ImpersonationLevel Identification</code> <para>Create a new security context with impersonation level of Identitification.</para> </example> <example> <code>$ctx = New-NtAlpcSecurityContext -Port $port -SecurityQualityOfService $sqos</code> <para>Create a new security context from a security quality of service.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.Port"> <summary> <para type="description">Specify the port to create the context from.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.Flags"> <summary> <para type="description">Specify the creation flags.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.ImpersonationLevel"> <summary> <para type="description">Specify the impersonation level.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.ContextTrackingMode"> <summary> <para type="description">Specify the list of attributes for the receive buffer.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.EffectiveOnly"> <summary> <para type="description">Specify the list of attributes for the receive buffer.</para> </summary> </member> <member name="P:NtObjectManager.NewNtAlpcSecurityContext.SecurityQualityOfService"> <summary> <para type="description">Specify the list of attributes for the receive buffer.</para> </summary> </member> <member name="M:NtObjectManager.NewNtAlpcSecurityContext.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtAlpcSecurityContext.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.GetNtDebugCmdlet"> <summary> <para type="synopsis">Open a NT debug object by path.</para> <para type="description">This cmdlet opens an existing NT debug object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtDebug \BaseNamedObjects\ABC</code> <para>Get a debug object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtDebug ABC -Root $root</code> <para>Get a debug object with a relative path. </para> </example> <example> <code>$obj = Get-NtDebug -Path \BaseNamedObjects\ABC
$obj.Wait()</code> <para>Get a debug object, wait for it to be set.</para> </example> <example> <code>$obj = Get-NtDebug -Path \BaseNamedObjects\ABC
$obj.Set()</code> <para>Get a debug object, and set it.</para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtDebug ABC</code> <para>Get a debug object with a relative path based on the current location. </para> </example> <example> <code>Get-NtDebug -Current</code> <para>Get the current debug object. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtDebugCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtDebugCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="P:NtObjectManager.GetNtDebugCmdlet.Current"> <summary> <para type="description">Open the current thread's debug object. Most parameters on this cmdlet will be ignored.</para> </summary> </member> <member name="M:NtObjectManager.GetNtDebugCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtDebugCmdlet"> <summary> <para type="synopsis">Create a new NT debug object.</para> <para type="description">This cmdlet creates a new NT debug object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle. You can also attach a process to the new debug object immediately after creation.</para> </summary> <example> <code>$obj = New-NtDebug</code> <para>Create a new anonymous debug object.</para> </example> <example> <code>$obj = New-NtDebug \BaseNamedObjects\ABC</code> <para>Create a new debug object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtDebug ABC -Root $root</code> <para>Create a new debug object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtDebug ABC</code> <para>Create a new debug object with a relative path based on the current location. </para> </example> <example> <code>$obj = New-NtDebug -ProcessId 12345</code> <para>Create a new anonymous debug object and attach to PID 12345.</para> </example> <example> <code>$obj = New-NtDebug -Process $proc</code> <para>Create a new anonymous debug object and attach to a process object.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtDebugCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtDebugCmdlet.ProcessId"> <summary> <para type="description">Specify a process ID to attach to after creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtDebugCmdlet.Process"> <summary> <para type="description">Specify a process to attach to after creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtDebugCmdlet.Flags"> <summary> <para type="description">Specify flags for create.</para> </summary> </member> <member name="M:NtObjectManager.NewNtDebugCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.DbgContinueStatus"> <summary> <para type="description">The allowed set of continue status</para> </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_EXCEPTION_HANDLED"> <summary> Exception is handled. </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_CONTINUE"> <summary> Continue thread. </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_EXCEPTION_NOT_HANDLED"> <summary> Exception not handled. </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_REPLY_LATER"> <summary> Reply later to the debug event. </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_TERMINATE_THREAD"> <summary> Terminate the thread being debugged. </summary> </member> <member name="F:NtObjectManager.DbgContinueStatus.DBG_TERMINATE_PROCESS"> <summary> Terminate the process being debugged. </summary> </member> <member name="T:NtObjectManager.StartNtDebugWait"> <summary> <para type="synopsis">Wait for an event on a debug object.</para> <para type="description">This cmdlet allows you to issue a wait for on a debug object. The timeout value is a combination of all the allowed time parameters, e.g. if you specify 1 second and 1000 milliseconds it will actually wait 2 seconds in total. Specifying -Infinite overrides the time parameters and will wait indefinitely.</para> </summary> <example> <code>$ev = Start-NtDebugWait $dbg</code> <para>Check for a debug event and return immediately.</para> </example> <example> <code>$ev = Start-NtDebugWait $dbg -Seconds 10</code> <para>Wait for 10 seconds for a debug event to be returned.</para> </example> <example> <code>$ev = Start-NtDebugWait $dbg -Infinite</code> <para>Wait indefinitely for a debug event to be returned.</para> </example> <example> <code>$ev = Start-NtDebugWait $dbg -Infinite -Alterable</code> <para>Wait indefinitely for a debug event to be returned in an alertable state.</para> </example> <example> <code>$ev = Start-NtDebugWait $dbg -Infinite -ContinueEvent</code> <para>Continue a previous event with the default continue state for the event and wait indefinitely for a debug event to be returned.</para> </example> <example> <code>$ev = Start-NtDebugWait $dbg -Infinite -ContinueEvent</code> <para>Continue a previous event with an explicit continue state for the event and wait indefinitely for a debug event to be returned.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.StartNtDebugWait.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.StartNtDebugWait.DebugObject"> <summary> <para type="description">Specify the debug object to wait on.</para> </summary> </member> <member name="P:NtObjectManager.StartNtDebugWait.Alertable"> <summary> <para type="description">Specify the wait should be alertable.</para> </summary> </member> <member name="P:NtObjectManager.StartNtDebugWait.ContinueEvent"> <summary> <para type="description">Specify an event to continue before waiting.</para> </summary> </member> <member name="P:NtObjectManager.StartNtDebugWait.ContinueStatus"> <summary> <para type="description">If continue event specified then this is the status to use.</para> </summary> </member> <member name="M:NtObjectManager.StartNtDebugWait.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.AddNtDebugProcess"> <summary> <para type="synopsis">Attach a process to a debug object.</para> <para type="description">This cmdlet attaches a process to a debug object. You can remove it again using Remove-NtDebugProcess.</para> </summary> <example> <code>Add-NtDebugProcess $dbg -ProcessId 12345</code> <para>Attach process 12345 to the debug object..</para> </example> <example> <code>Add-NtDebugProcess $dbg -Process $proc</code> <para>Attach a process object to the debug object..</para> </example> </member> <member name="P:NtObjectManager.AddNtDebugProcess.DebugObject"> <summary> <para type="description">Specify the debug object to attach the process to.</para> </summary> </member> <member name="P:NtObjectManager.AddNtDebugProcess.ProcessId"> <summary> <para type="description">Specify a process ID to attach to .</para> </summary> </member> <member name="P:NtObjectManager.AddNtDebugProcess.Process"> <summary> <para type="description">Specify a process to attach to.</para> </summary> </member> <member name="M:NtObjectManager.AddNtDebugProcess.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.RemoveNtDebugProcess"> <summary> <para type="synopsis">Detach a process from a debug object.</para> <para type="description">This cmdlet detachs a process remove a debug object.</para> </summary> <example> <code>Remove-NtDebugProcess $dbg -ProcessId 12345</code> <para>Detach process 12345 from the debug object..</para> </example> <example> <code>Remove-NtDebugProcess $dbg -Process $proc</code> <para>Detach process object from the debug object..</para> </example> </member> <member name="P:NtObjectManager.RemoveNtDebugProcess.DebugObject"> <summary> <para type="description">Specify the debug object to debug the process from.</para> </summary> </member> <member name="P:NtObjectManager.RemoveNtDebugProcess.ProcessId"> <summary> <para type="description">Specify a process ID to detach.</para> </summary> </member> <member name="P:NtObjectManager.RemoveNtDebugProcess.Process"> <summary> <para type="description">Specify a process to detach.</para> </summary> </member> <member name="M:NtObjectManager.RemoveNtDebugProcess.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetNtEnlistmentCmdlet"> <summary> <para type="synopsis">Open a NT Enlistment object or all from a Resource Manager.</para> <para type="description">This cmdlet opens an existing NT Enlistment object or all from a Resource Manager.</para> </summary> <example> <code>$obj = Get-NtEnlistment -ResourceManager $rm</code> <para>Get all Enlistment objects from a Resource Manager.</para> </example> <example> <code>$obj = Get-NtEnlistment -EnlistmentGuid '04422e91-63c2-4025-944d-d66fae133274' -ResourceManager $rm</code> <para>Get a Enlistment object from its GUID and Resource Manager.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtEnlistmentCmdlet.EnlistmentGuid"> <summary> <para type="description">Specify the Enlistment GUID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtEnlistmentCmdlet.ResourceManager"> <summary> <para type="description">Specify the Transaction Manager containing the Resource Manager.</para> </summary> </member> <member name="M:NtObjectManager.GetNtEnlistmentCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtEnlistmentCmdlet"> <summary> <para type="synopsis">Creates a new NT Resource Manager object.</para> <para type="description">This cmdlet creates a new NT Resource Manager object.</para> </summary> <example> <code>$obj = New-NtEnlistment -ResourceManager $rm -Transaction $t </code> <para>Create an Enslitment with a Resource Manager and Transaction.</para> </example> <example> <code>$obj = New-NtEnlistment -AutoGenerateGuid -TransactionManager $tm </code> <para>Create a Resource Manager object with an auto-generated GUID.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtEnlistmentCmdlet.ResourceManager"> <summary> <para type="description">Specify the Resource Manager to contain the Enlistment.</para> </summary> </member> <member name="P:NtObjectManager.NewNtEnlistmentCmdlet.Transaction"> <summary> <para type="description">Specify the Transaction to associate with the Enlistment.</para> </summary> </member> <member name="P:NtObjectManager.NewNtEnlistmentCmdlet.CreateFlags"> <summary> <para type="description">Specify flags for Enlistment creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtEnlistmentCmdlet.NotificationMask"> <summary> <para type="description">Specify the notification mask for the Enlistment creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtEnlistmentCmdlet.EnlistmentKey"> <summary> <para type="description">Specify a key to associate with the Enlistment.</para> </summary> </member> <member name="M:NtObjectManager.NewNtEnlistmentCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtEnlistmentCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtPartitionCmdlet"> <summary> <para type="synopsis">Open a NT partition object.</para> <para type="description">This cmdlet opens an existing NT partition object.</para> </summary> <example> <code>$obj = Get-NtPartition \BaseNamedObjects\ABC</code> <para>Get a partition object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtPartition ABC -Root $root</code> <para>Get a partition object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtPartition ABC</code> <para>Get a partition object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtPartitionCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtPartitionCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtPartitionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtPartitionCmdlet"> <summary> <para type="synopsis">Creates a new NT partition object.</para> <para type="description">This cmdlet creates a new NT partition object.</para> </summary> <example> <code>$obj = New-NtPartition \BaseNamedObjects\ABC</code> <para>Create a partition object with an absolute path.</para> </example> <example> <code>$obj = New-NtPartition \BaseNamedObjects\ABC -PreferredNode 2</code> <para>Create a partition object with an absolute path and preferred node 2.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtPartition ABC -Root $root</code> <para>Create a partition object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtPartition ABC</code> <para>Create a partition object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtPartitionCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.NewNtPartitionCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtPartitionCmdlet.PreferredNode"> <summary> <para type="description">Specifies the preferred NUMA node, -1 means ideal node.</para> </summary> </member> <member name="P:NtObjectManager.NewNtPartitionCmdlet.ParentPartition"> <summary> <para type="description">Specifies the parent partition. Not specifying means use the system partition.</para> </summary> </member> <member name="M:NtObjectManager.NewNtPartitionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtResourceManagerCmdlet"> <summary> <para type="synopsis">Open a NT Resource Manager object or all from a Transaction Manager..</para> <para type="description">This cmdlet opens an existing NT Resource Manager object.</para> </summary> <example> <code>$obj = Get-NtTransaction -TransactionManager $tm</code> <para>Get all Resource Manager objects from a Transaction Manager.</para> </example> <example> <code>$obj = Get-NtTransaction -ResourceManagerGuid '04422e91-63c2-4025-944d-d66fae133274' -TransactionManager $tm</code> <para>Get a Resource Manager object from its GUID and Transaction Manager.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtResourceManagerCmdlet.ResourceManagerGuid"> <summary> <para type="description">Specify the Resource Manager GUID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtResourceManagerCmdlet.TransactionManager"> <summary> <para type="description">Specify the Transaction Manager containing the Resource Manager.</para> </summary> </member> <member name="M:NtObjectManager.GetNtResourceManagerCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtResourceManagerCmdlet"> <summary> <para type="synopsis">Creates a new NT Resource Manager object.</para> <para type="description">This cmdlet creates a new NT Resource Manager object.</para> </summary> <example> <code>$obj = New-NtResourceManager -TransactionManager $tm </code> <para>Create a Resource Manager object with an auto-generated GUID.</para> </example> <example> <code>$obj = New-NtResourceManager -ResourceManagerGuid '04422e91-63c2-4025-944d-d66fae133274' -TransactionManager $tm </code> <para>Create a Resource Manager object with a specified GUID.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtResourceManagerCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.NewNtResourceManagerCmdlet.ResourceManagerGuid"> <summary> <para type="description">Specify the Resource Manager GUID to create.</para> </summary> </member> <member name="P:NtObjectManager.NewNtResourceManagerCmdlet.TransactionManager"> <summary> <para type="description">Specify the Transaction Manager to contain the Resource Manager.</para> </summary> </member> <member name="P:NtObjectManager.NewNtResourceManagerCmdlet.CreateFlags"> <summary> <para type="description">Specify flags for resource manager creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtResourceManagerCmdlet.Description"> <summary> <para type="description">Specify an optional description.</para> </summary> </member> <member name="M:NtObjectManager.NewNtResourceManagerCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtResourceManagerCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtTransactionCmdlet"> <summary> <para type="synopsis">Open a NT transaction object or get all accessible transaction objects.</para> <para type="description">This cmdlet opens an existing NT transaction object or can get all accessible transaction objects.</para> </summary> <example> <code>$obj = Get-NtTransaction</code> <para>Get all accessible transaction objects.</para> </example> <example> <code>$obj = Get-NtTransaction -TransactionManager $tm</code> <para>Get all accessible transaction objects in a specific transaction manager.</para> </example> <example> <code>$obj = Get-NtTransaction -UnitOfWork '04422e91-63c2-4025-944d-d66fae133274'</code> <para>Get a transaction object from its Unit of Work GUID.</para> </example> <example> <code>$obj = Get-NtTransaction -UnitOfWork '04422e91-63c2-4025-944d-d66fae133274' -TransactionManager $tm</code> <para>Get a transaction object from its Unit of Work GUID from a specific transaction manager.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtTransactionCmdlet.UnitOfWork"> <summary> <para type="description">Specify the Unit of Work GUID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionCmdlet.TransactionManager"> <summary> <para type="description">Specify an optional Transaction Manager.</para> </summary> </member> <member name="M:NtObjectManager.GetNtTransactionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtTransactionCmdlet"> <summary> <para type="synopsis">Creates a new NT transaction object.</para> <para type="description">This cmdlet creates a new NT transaction object.</para> </summary> <example> <code>$obj = New-NtTransaction \BaseNamedObjects\ABC</code> <para>Create a transaction object with an absolute path.</para> </example> <example> <code>$obj = New-NtTransaction \BaseNamedObjects\ABC -PreferredNode 2</code> <para>Create a transaction object with an absolute path and preferred node 2.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtTransaction ABC -Root $root</code> <para>Create a transaction object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtTransaction ABC</code> <para>Create a transaction object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.UnitOfWork"> <summary> <para type="description">Specify an optional Unit of Work GUID.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.TransactionManager"> <summary> <para type="description">Specify an optional Transaction Manager.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.CreateFlags"> <summary> <para type="description">Specify flags for transaction creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.IsolationLevel"> <summary> <para type="description">Specify an optional isolation level.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.IsolationFlags"> <summary> <para type="description">Specify isolation falgs.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.Timeout"> <summary> <para type="description">Specify timeout in milliseconds (0 is Infinite).</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionCmdlet.Description"> <summary> <para type="description">Specify an optional description.</para> </summary> </member> <member name="M:NtObjectManager.NewNtTransactionCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtTransactionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtTransactionGuidCmdlet"> <summary> <para type="synopsis">Enumerates Kernel Transaction Manager object GUIDs.</para> <para type="description">This cmdlet enumerates exiting Kernel Transaction Manager objects and returns the GUIDs associaed with the objects.</para> </summary> <example> <code>$obj = Get-NtTransactionGuid -Type Transaction</code> <para>Get all transaction object GUIDs.</para> </example> <example> <code>$obj = Get-NtTransactionGuid -Type TransactionManager</code> <para>Get all transaction manager object GUIDs.</para> </example> <example> <code>$obj = Get-NtTransactionGuid -Type Transaction -TransactionManager $tm</code> <para>Get all transaction object GUIDs from a transaction manager.</para> </example> <example> <code>$obj = Get-NtTransactionGuid -Type ResourceManager -TransactionManager $tm</code> <para>Get all resource manager object GUIDs from a transaction manager.</para> </example> <example> <code>$obj = Get-NtTransactionGuid -Type Enlistment -ResourceManager $rm</code> <para>Get all enlistment object GUIDs from a resource manager.</para> </example> </member> <member name="P:NtObjectManager.GetNtTransactionGuidCmdlet.Type"> <summary> <para type="description">Specify the object type for the enumeration.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionGuidCmdlet.ResourceManager"> <summary> <para type="description">Specify the Resource Manager for the enumeration (needed for enlistments).</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionGuidCmdlet.TransactionManager"> <summary> <para type="description">Specify the Transaction Manager for the enumeration (needed for resource manager, optional for transactions).</para> </summary> </member> <member name="M:NtObjectManager.GetNtTransactionGuidCmdlet.ProcessRecord"> <summary> Process records. </summary> </member> <member name="T:NtObjectManager.GetNtTransactionManagerCmdlet"> <summary> <para type="synopsis">Open a NT transaction manager object or all transaction manager objects.</para> <para type="description">This cmdlet opens an existing NT transaction manager object or all transaction manager objects.</para> </summary> <example> <code>$obj = Get-NtTransactionManager</code> <para>Get all accessible transaction manager objects.</para> </example> <example> <code>$obj = Get-NtTransactionManager \BaseNamedObjects\ABC</code> <para>Get a transaction manager object with an absolute path.</para> </example> <example> <code>$obj = Get-NtTransactionManager -Identity '04422e91-63c2-4025-944d-d66fae133274'</code> <para>Get a transaction manager object from its identity GUID.</para> </example> <example> <code>$obj = Get-NtTransactionManager \??\c:\abc\xyz</code> <para>Get a transaction manager object from an existing logfile.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtTransactionManager ABC -Root $root</code> <para>Get a transaction manager object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtTransactionManager ABC</code> <para>Get a transaction manager object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtTransactionManagerCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionManagerCmdlet.Identity"> <summary> <para type="description">Specify a identity GUID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionManagerCmdlet.OpenFlags"> <summary> <para type="description">Specify optional open flags..</para> </summary> </member> <member name="P:NtObjectManager.GetNtTransactionManagerCmdlet.LogFile"> <summary> <para type="description">Specify that the path resolves to a logfile rather than an object manager path.</para> </summary> </member> <member name="M:NtObjectManager.GetNtTransactionManagerCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.GetNtTransactionManagerCmdlet.ResolvePath"> <summary> Virtual method to resolve the value of the Path variable. </summary> <returns>The object path, returns null if resolving a log file.</returns> </member> <member name="M:NtObjectManager.GetNtTransactionManagerCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtTransactionManagerCmdlet"> <summary> <para type="synopsis">Creates a new NT transaction manager object.</para> <para type="description">This cmdlet creates a new NT transaction object.</para> </summary> <example> <code>$obj = New-NtTransaction \BaseNamedObjects\ABC</code> <para>Create a transaction manager object with an absolute path.</para> </example> <example> <code>$obj = New-NtTransaction \BaseNamedObjects\ABC -PreferredNode 2</code> <para>Create a transaction manager object with an absolute path and preferred node 2.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtTransaction ABC -Root $root</code> <para>Create a transaction manager object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtTransaction ABC</code> <para>Create a transaction manager object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtTransactionManagerCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.NewNtTransactionManagerCmdlet.CreateFlags"> <summary> <para type="description">Specify flags for transaction manager creation.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionManagerCmdlet.CommitStrength"> <summary> <para type="description">Specify an optional commit strength.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTransactionManagerCmdlet.LogFileName"> <summary> <para type="description">Specify an optional log file name.</para> </summary> </member> <member name="M:NtObjectManager.NewNtTransactionManagerCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtTransactionManagerCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.TextEncodingType"> <para type="description">Enumeration to specify a text encoding.</para> </member> <member name="F:NtObjectManager.TextEncodingType.Binary"> <summary> Binary raw text. </summary> </member> <member name="F:NtObjectManager.TextEncodingType.Unicode"> <summary> 16 bit unicode text. </summary> </member> <member name="F:NtObjectManager.TextEncodingType.BigEndianUnicode"> <summary> Big Endian 16 bit unicode text. </summary> </member> <member name="F:NtObjectManager.TextEncodingType.UTF8"> <summary> UTF8 </summary> </member> <member name="F:NtObjectManager.TextEncodingType.UTF32"> <summary> UTF32 </summary> </member> <member name="F:NtObjectManager.TextEncodingType.UTF7"> <summary> UTF7 </summary> </member> <member name="T:NtObjectManager.ModifiedRpcServerResult"> <summary> Result of a modified RPC server. </summary> </member> <member name="P:NtObjectManager.ModifiedRpcServerResult.Server"> <summary> The server which was modified. </summary> </member> <member name="P:NtObjectManager.ModifiedRpcServerResult.CompareServer"> <summary> The original compare server. </summary> </member> <member name="P:NtObjectManager.ModifiedRpcServerResult.AddedProcedure"> <summary> A collection of added procedures. </summary> </member> <member name="P:NtObjectManager.ModifiedRpcServerResult.AddedProcedureCount"> <summary> The count of added procedures. </summary> </member> <member name="T:NtObjectManager.CompareRpcServerResult"> <summary> <para type="description">Result of a RPC server comparison.</para> </summary> </member> <member name="P:NtObjectManager.CompareRpcServerResult.AddedServer"> <summary> Collection of added servers in comparison. </summary> </member> <member name="P:NtObjectManager.CompareRpcServerResult.ModifiedServer"> <summary> Collection of modified servers in comparison. </summary> </member> <member name="P:NtObjectManager.CompareRpcServerResult.AddedServerCount"> <summary> Count of added servers. </summary> </member> <member name="P:NtObjectManager.CompareRpcServerResult.ModifiedServerCount"> <summary> Count of modified servers. </summary> </member> <member name="T:NtObjectManager.CompareRpcServerCmdlet"> <summary> <para type="synopsis">Compare two lists of RPC server objects for differences.</para> <para type="description">This cmdlet compares two lists of RPC server objects for differences. It highlights servers which didn't exist before, servers removed from the list as well as servers which have been modified in some way.</para> </summary> <example> <code>Compare-RpcServer -Server $old -CompareServer $new</code> <para>Compare a list of old servers in $old with ones in $new.</para> </example> </member> <member name="P:NtObjectManager.CompareRpcServerCmdlet.Server"> <summary> <para type="description">Specify a list of RPC servers for comparison.</para> </summary> </member> <member name="P:NtObjectManager.CompareRpcServerCmdlet.CompareServer"> <summary> <para type="description">Specify a list of RPC servers to compare against Server.</para> </summary> </member> <member name="M:NtObjectManager.CompareRpcServerCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.SelectRpcServerCmdlet"> <summary> <para type="synopsis">Selects RPC server objects based on some specific criteria.</para> <para type="description">This cmdlet selects out RPC servers from a list based on a few specific criteria such as partial name match or specific parameter types.</para> </summary> <example> <code>$rpc | Select-RpcServer -Name "Start"</code> <para>Select all servers which have a procedure containing the text Start.</para> </example> <example> <code>$rpc | Select-RpcServer -SystemHandle</code> <para>Select all servers which have a procedure which take a system handle parameter.</para> </example> <example> <code>$rpc | Select-RpcServer -SystemHandle -SystemHandleType File</code> <para>Select all servers which have a procedure which take a system handle parameter of type File.</para> </example> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.Server"> <summary> <para type="description">Specify a list of RPC servers for selecting.</para> </summary> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.Name"> <summary> <para type="description">Specify name to partially match against a function name.</para> </summary> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.SystemHandle"> <summary> <para type="description">Specify one function must take a system handle parameter.</para> </summary> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.SystemHandleType"> <summary> <para type="description">Specify an optional type of system handle to match.</para> </summary> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.InterfaceId"> <summary> <para type="description">Specify the Interface ID to match.</para> </summary> </member> <member name="P:NtObjectManager.SelectRpcServerCmdlet.InterfaceVersion"> <summary> <para type="description">Specify an optional interface version to match.</para> </summary> </member> <member name="M:NtObjectManager.SelectRpcServerCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetRpcServerName"> <summary> <para type="synopsis">Get the names from a RPC server as XML.</para> <para type="description">This cmdlet extracts the names from a RPC server instance and generates an XML file for easy editing. You can then update the names with Set-RpcServerName.</para> </summary> <example> <code>Get-RpcServerName -Server $server</code> <para>Get names for an RPC server object.</para> </example> </member> <member name="P:NtObjectManager.GetRpcServerName.Server"> <summary> <para type="description">Specify the server object to get the names from.</para> </summary> </member> <member name="M:NtObjectManager.GetRpcServerName.ProcessRecord"> <summary> Process record override. </summary> </member> <member name="T:NtObjectManager.SetRpcServerName"> <summary> <para type="synopsis">Set the names of a RPC server from XML.</para> <para type="description">This cmdlet extracts updates the names for a RPC server instance from XML data. You can get the names with Get-RpcServerName.</para> </summary> <example> <code>Set-RpcServerName -Server $server -Names $xml</code> <para>Set names for an RPC server object from a string.</para> </example> <example> <code>Get-Content names.xml | Set-RpcServerName -Server $server</code> <para>Set names for an RPC server object from a file.</para> </example> </member> <member name="P:NtObjectManager.SetRpcServerName.Server"> <summary> <para type="description">Specify the server object to update the names on.</para> </summary> </member> <member name="P:NtObjectManager.SetRpcServerName.Xml"> <summary> <para type="description">Specify the XML data which contains the names to update.</para> </summary> </member> <member name="M:NtObjectManager.SetRpcServerName.ProcessRecord"> <summary> Process record override. </summary> </member> <member name="M:NtObjectManager.SetRpcServerName.EndProcessing"> <summary> End processing override. </summary> </member> <member name="T:NtObjectManager.TestNetworkAccessCmdlet"> <summary> <para type="synopsis">Test whether network access is allowed based on a specific token.</para> <para type="description">This cmdlet tests network access for a particular token. This can either be network client access or network server access.</para> </summary> <example> <code>Test-NetworkAccess -HostName www.google.com -Port 80</code> <para>Test network access for the current user to www.google.com:80.</para> </example> <example> <code>Test-NetworkAccess -Listen 1234</code> <para>Test network access for the current user by listening on port 1234.</para> </example> <example> <code>Test-NetworkAccess -HostName www.google.com -Port 80 -ProcessId 1234</code> <para>Test network access for the process 1234 to www.google.com:80.</para> </example> <example> <code>Test-NetworkAccess -HostName www.google.com -Port 80 -Token $token</code> <para>Test network access for a specified token to www.google.com:80.</para> </example> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.Listen"> <summary> <para type="description">Specify to test listening on a port.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.HostName"> <summary> <para type="description">Specify to the host for connecting or listening.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.Port"> <summary> <para type="description">Specify to the host for connecting or listening.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.Process"> <summary> <para type="description">Specify a process to get the token from.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.ProcessId"> <summary> <para type="description">Specify a process ID to get the token from.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.Token"> <summary> <para type="description">Specify the token to use for the test.</para> </summary> </member> <member name="P:NtObjectManager.TestNetworkAccessCmdlet.IPv6"> <summary> <para type="description">Specify to use IPv6 instead of IPv4.</para> </summary> </member> <member name="M:NtObjectManager.TestNetworkAccessCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.AddDosDeviceCmdlet"> <summary> <para type="synopsis">Create a DOS device symlink.</para> <para type="description">This cmdlet creates or redefines a DOS device symlink. This symlink will be permanent, until it's deleted rather than requiring a handle to be maintained.</para> </summary> <example> <code>Add-DosDevice Z: C:\Windows</code> <para>Define a Z: drive which points to C:\Windows.</para> </example> <example> <code>Add-DosDevice Z: \Device\HarddiskVolume1\windows -RawTargetPath</code> <para>Define a Z: drive which points to Windows using a raw target path.</para> </example> <example> <code>Add-DosDevice "\RPC Control\ABC" c:\Windows</code> <para>Define the symlink '\RPC Control\ABC' drive which points to c:\Windows.</para> </example> <example> <code>Add-DosDevice Z: C:\Windows -NoBroadcastSystem</code> <para>Define a Z: drive which points to C:\Windows but don't broadcast the changes to applications on the desktop.</para> </example> </member> <member name="P:NtObjectManager.AddDosDeviceCmdlet.DeviceName"> <summary> <para type="description">The device name to create. If this string starts with a \ then the symlink will be created relative to the root of the object manager.</para> </summary> </member> <member name="P:NtObjectManager.AddDosDeviceCmdlet.TargetPath"> <summary> <para type="description">Specify the target path. This should be a DOS path, unless RawTargetPath is set then it can be arbitrary object manager path.</para> </summary> </member> <member name="P:NtObjectManager.AddDosDeviceCmdlet.NoBroadcastSystem"> <summary> <para type="description">Don't broadcast the change to the desktop using WM_SETTINGCHANGE.</para> </summary> </member> <member name="P:NtObjectManager.AddDosDeviceCmdlet.RawTargetPath"> <summary> <para type="description">Specify the TargetPath as a raw object manager path.</para> </summary> </member> <member name="M:NtObjectManager.AddDosDeviceCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord. </summary> </member> <member name="T:NtObjectManager.RemoveDosDeviceCmdlet"> <summary> <para type="synopsis">Remove a DOS device symlink.</para> <para type="description">This cmdlet removes a DOS device symlink.</para> </summary> <example> <code>Remove-DosDevice Z:</code> <para>Remove the Z: drive.</para> </example> <example> <code>Remove-DosDevice Z: \Device\HarddiskVolume1\windows -RawTargetPath</code> <para>Remove the Z: drive, which must point to \Device\HarddiskVolume1\Windows.</para> </example> <example> <code>Remove-DosDevice Z: c:\windows</code> <para>Remove the Z: drive, which must point to c:\Windows.</para> </example> <example> <code>Remove-DosDevice "\RPC Control\ABC"</code> <para>Remove '\RPC Control\ABC' symlink.</para> </example> </member> <member name="P:NtObjectManager.RemoveDosDeviceCmdlet.DeviceName"> <summary> <para type="description">The device name to create. If this string starts with a \ then the symlink will be created relative to the root of the object manager.</para> </summary> </member> <member name="P:NtObjectManager.RemoveDosDeviceCmdlet.ExactMatchTargetPath"> <summary> <para type="description">Specify an exact target path to remove. If the symlink doesn't match this target then it will not be removed.</para> </summary> </member> <member name="P:NtObjectManager.RemoveDosDeviceCmdlet.NoBroadcastSystem"> <summary> <para type="description">Don't broadcast the change to the desktop using WM_SETTINGCHANGE.</para> </summary> </member> <member name="P:NtObjectManager.RemoveDosDeviceCmdlet.RawTargetPath"> <summary> <para type="description">Specify the TargetPath as a raw object manager path.</para> </summary> </member> <member name="M:NtObjectManager.RemoveDosDeviceCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord. </summary> </member> <member name="T:NtObjectManager.AccessCheckResult"> <summary> <para type="description">General Access check result.</para> </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.Name"> <summary> The name of the object which was accessed (depends on the type). </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.TypeName"> <summary> Name of the type accessed. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.GrantedAccess"> <summary> Granted access. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.GrantedAccessString"> <summary> Get granted access as a type specific string </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.GrantedGenericAccessString"> <summary> Get granted access as generic access string. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.GenericMapping"> <summary> The generic mapping associated with this type. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.SecurityDescriptor"> <summary> The security descriptor associated with this access check. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.TokenInfo"> <summary> Information the token used in the access check. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.IsRead"> <summary> Was read access granted? </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.IsWrite"> <summary> Was write access granted? </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.IsExecute"> <summary> Was execute access granted? </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.IsAll"> <summary> Was all access granted? </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.IsDirectory"> <summary> Is the resource being access a directory. </summary> </member> <member name="P:NtObjectManager.AccessCheckResult.TokenId"> <summary> Unique key for access check result (based on TokenId) </summary> </member> <member name="T:NtObjectManager.TokenInformation"> <summary> Information about a token. </summary> </member> <member name="P:NtObjectManager.TokenInformation.UserName"> <summary> Token username </summary> </member> <member name="P:NtObjectManager.TokenInformation.IntegrityLevel"> <summary> Token integrity level </summary> </member> <member name="P:NtObjectManager.TokenInformation.TokenType"> <summary> Token type </summary> </member> <member name="P:NtObjectManager.TokenInformation.ImpersonationLevel"> <summary> Token impersonation level </summary> </member> <member name="P:NtObjectManager.TokenInformation.TokenId"> <summary> Token ID </summary> </member> <member name="P:NtObjectManager.TokenInformation.Elevated"> <summary> Elevated token </summary> </member> <member name="P:NtObjectManager.TokenInformation.Restricted"> <summary> Restricted token </summary> </member> <member name="P:NtObjectManager.TokenInformation.AppContainer"> <summary> App container token </summary> </member> <member name="P:NtObjectManager.TokenInformation.AppContainerSid"> <summary> App container SID (if an AppContainer) </summary> </member> <member name="P:NtObjectManager.TokenInformation.LowPrivilegeAppContainer"> <summary> Low privilege AC </summary> </member> <member name="P:NtObjectManager.TokenInformation.SessionId"> <summary> The session ID of the token. </summary> </member> <member name="P:NtObjectManager.TokenInformation.SourceData"> <summary> Additonal information of where the token was sourced from </summary> </member> <member name="M:NtObjectManager.TokenInformation.ToString"> <summary> Overridden ToString. </summary> <returns></returns> </member> <member name="T:NtObjectManager.CommonAccessBaseCmdlet"> <summary> Common base cmdlet for commands which look at accessible resources. </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseCmdlet.ProcessIds"> <summary> <para type="description">Specify a list of process IDs to open for their tokens.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseCmdlet.ProcessNames"> <summary> <para type="description">Specify a list of process names to open for their tokens.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseCmdlet.ProcessCommandLines"> <summary> <para type="description">Specify a list of command lines to filter on find for the process tokens.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseCmdlet.Tokens"> <summary> <para type="description">Specify a list token objects.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseCmdlet.Processes"> <summary> <para type="description">Specify a list of process objects to get tokens from.</para> </summary> </member> <member name="M:NtObjectManager.CommonAccessBaseCmdlet.ProcessRecord"> <summary> Overridden process record method. </summary> </member> <member name="T:NtObjectManager.CommonAccessBaseWithAccessCmdlet`1"> <summary> Base class for accessible checks with an access parameter. </summary> <typeparam name="A">The type of access rights to check against.</typeparam> </member> <member name="P:NtObjectManager.CommonAccessBaseWithAccessCmdlet`1.AccessRights"> <summary> <para type="description">Access rights to check for in an object's access.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseWithAccessCmdlet`1.AllowPartialAccess"> <summary> <para type="description">If AccessRights specified require that only part of the access rights are required to match an access check.</para> </summary> </member> <member name="P:NtObjectManager.CommonAccessBaseWithAccessCmdlet`1.AllowEmptyAccess"> <summary> <para type="description">If set an access entry will be generated even if granted access is 0.</para> </summary> </member> <member name="T:NtObjectManager.GetAccessiblePathCmdlet`1"> <summary> Base class for path based accessible checks. </summary> </member> <member name="P:NtObjectManager.GetAccessiblePathCmdlet`1.Path"> <summary> <para type="description">Specify a list of native paths to check.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessiblePathCmdlet`1.Win32Path"> <summary> <para type="description">Specify a list of paths in a Win32 format.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessiblePathCmdlet`1.FormatWin32Path"> <summary> <para type="description">When generating the results format path in Win32 format.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessiblePathCmdlet`1.Recurse"> <summary> <para type="description">Specify whether to recursively check the path for access.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessiblePathCmdlet`1.MaxDepth"> <summary> <para type="description">When recursing specify maximum depth.</para> </summary> </member> <member name="M:NtObjectManager.GetAccessiblePathCmdlet`1.ConvertWin32Path(System.String)"> <summary> Convert a Win32 path to a native path. </summary> <param name="win32_path">The Win32 path to convert.</param> <returns>The converted native path.</returns> </member> <member name="M:NtObjectManager.GetAccessiblePathCmdlet`1.RunAccessCheckPath(System.Collections.Generic.IEnumerable{NtObjectManager.TokenEntry},System.String)"> <summary> Run an access check with a path. </summary> <param name="tokens">The list of tokens.</param> <param name="path">The path to check.</param> </member> <member name="T:NtObjectManager.GenericObjectSecurity"> <summary> Generic object security which takes an integer access mask. </summary> </member> <member name="M:NtObjectManager.GenericObjectSecurity.#ctor"> <summary> Constructor </summary> </member> <member name="M:NtObjectManager.GenericObjectSecurity.#ctor(NtApiDotNet.NtObject,System.Security.AccessControl.AccessControlSections)"> <summary> Constructor taking security descriptor from an object. </summary> <param name="obj">The NT object to extract the security descriptor from.</param> <param name="include_sections">Indicates which bits of the security descriptor you want to include.</param> </member> <member name="T:NtObjectManager.DeviceAccessCheckResult"> <summary> <para type="description">Access check result for a device.</para> </summary> </member> <member name="P:NtObjectManager.DeviceAccessCheckResult.NamespacePath"> <summary> Indicates this was a namespace open </summary> </member> <member name="P:NtObjectManager.DeviceAccessCheckResult.DeviceType"> <summary> Indicates the type of device. </summary> </member> <member name="P:NtObjectManager.DeviceAccessCheckResult.Characteristics"> <summary> Indicates the device characteristics. </summary> </member> <member name="T:NtObjectManager.DeviceCheckMode"> <summary> <para type="description">Mode for checking device object.</para> </summary> </member> <member name="F:NtObjectManager.DeviceCheckMode.DeviceOnly"> <summary> Only check root device. </summary> </member> <member name="F:NtObjectManager.DeviceCheckMode.NamespaceOnly"> <summary> Only check device namespace. </summary> </member> <member name="F:NtObjectManager.DeviceCheckMode.DeviceAndNamespace"> <summary> Check device and namespace. </summary> </member> <member name="T:NtObjectManager.GetAccessibleDeviceCmdlet"> <summary> <para type="synopsis">Get a list of devices that can be opened by a specified token.</para> <para type="description">This cmdlet checks a device and optionally tries to determine if one or more specified tokens can open it. If no tokens are specified the current process token is used.</para> </summary> <example> <code>Get-AccessibleDevice \Device</code> <para>Check accessible devices under \Device for the current process token.</para> </example> <example> <code>Get-AccessibleDevice \Device -AccessRights GenericWrite</code> <para>Check write accessible devices under \Device for the current process token.</para> </example> <example> <code>Get-AccessibleDevice \Device -ProcessIds 1234,5678</code> <para>Check accessible devices under \Device for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>Get-AccessibleDevice \Device -CheckMode DeviceAndNamespace</code> <para>Check accessible devices under \Device for the current process token including ones under a namespace.</para> </example> <example> <code>Get-AccessibleDevice \ -Recurse</code> <para>Check recursively for accessible devices under \ for the current process token.</para> </example> <example> <code>Get-AccessibleDevice \ -Recurse -MaxDepth 5</code> <para>Check recursively for accessible objects under \BaseNamedObjects for the current process token to a maximum depth of 5.</para> </example> <example> <code>Get-AccessibleDevice \Device\Afd,\Device\Blah</code> <para>Check two devices for the current process token.</para> </example> <example> <code>Get-AccessibleDevice \ -Recurse -AccessRights GenericWrite</code> <para>Check recursively for accessible devices under with write access.</para> </example> <example> <code>Get-AccessibleDevice \ -Recurse -AccessRights GenericWrite -AllowPartialAccess</code> <para>Check recursively for accessible devices with partial write access.</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleDevice \Device -Recurse -Tokens $token -AccessRights GenericWrite</code> <para>Get all devices which can be written to in \Device by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.Path"> <summary> <para type="description">Specify a list of native paths to check. Can refer to object directories to search for device objects or explicit paths.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.Recurse"> <summary> <para type="description">Specify whether to recursively check the directories for devices.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.MaxDepth"> <summary> <para type="description">When recursing specify maximum depth.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.CheckMode"> <summary> <para type="description">Check mode for device and/or namespace.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.NamespacePath"> <summary> <para type="description">If check mode allows namespace paths specify a list of namespace paths to check for access to the device namespace instead of a default.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.CheckEaBuffer"> <summary> <para type="description">Check whether the device can be accessed with an EA buffer.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.EaBuffer"> <summary> <para type="description">If CheckEaBuffer enabled specify an explicit buffer instead of a default.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleDeviceCmdlet.OpenOptions"> <summary> <para type="description">Specify open options for access.</para> </summary> </member> <member name="T:NtObjectManager.FileCheckMode"> <summary> <para type="description">Limit access check to specific types of files.</para> </summary> </member> <member name="F:NtObjectManager.FileCheckMode.All"> <summary> Check files and directories for access. </summary> </member> <member name="F:NtObjectManager.FileCheckMode.FilesOnly"> <summary> Check files only. </summary> </member> <member name="F:NtObjectManager.FileCheckMode.DirectoriesOnly"> <summary> Check directories only. </summary> </member> <member name="T:NtObjectManager.GetAccessibleFileCmdlet"> <summary> <para type="synopsis">Get a list of files that can be opened by a specified token.</para> <para type="description">This cmdlet checks a file or directory and tries to determine if one or more specified tokens can open them. If no tokens are specified the current process token is used.</para> </summary> <example> <code>Get-AccessibleFile \??\C:\Windows</code> <para>Check accessible file c:\Windows for the current process token.</para> </example> <example> <code>Get-AccessibleFile \??\C:\Windows -ProcessIds 1234,5678</code> <para>Check accessible file c:\Windows for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>Get-AccessibleFile \??\C:\Windows -Recurse</code> <para>Check recursively for check accessible files under c:\Windows for the current process token.</para> </example> <example> <code>Get-AccessibleFile -Win32Path C:\Windows -Recurse</code> <para>Check recursively for check accessible files under c:\Windows for the current process token using a Win32 path.</para> </example> <example> <code>Get-AccessibleFile -Win32Path C:\Windows -Recurse -MaxDepth 2</code> <para>Check recursively for check accessible files under c:\Windows for the current process token using a Win32 path with a max depth of 2.</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleFile \??\C:\Windows -Recurse -Tokens $token -AccessRights GenericWrite</code> <para>Get all files with can be written to \??\C:\Windows by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleFileCmdlet.DirectoryAccessRights"> <summary> <para type="description">Specify a set of directory access rights which a directory must at least be accessible for to count as an access.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleFileCmdlet.CheckMode"> <summary> <para type="description">Limit access check to specific types of files.</para> </summary> </member> <member name="M:NtObjectManager.GetAccessibleFileCmdlet.ConvertWin32Path(System.String)"> <summary> Convert a Win32 Path to a Native NT path. </summary> <param name="win32_path">The win32 path to convert.</param> <returns>The native path.</returns> </member> <member name="M:NtObjectManager.GetAccessibleFileCmdlet.BeginProcessing"> <summary> Override for begin processing. </summary> </member> <member name="T:NtObjectManager.HandleAccessCheckResult"> <summary> <para type="description">Access check result for a handle.</para> </summary> </member> <member name="P:NtObjectManager.HandleAccessCheckResult.MaximumAccess"> <summary> Specifies the maximum access that can be accessed if the resource was reopened. </summary> </member> <member name="P:NtObjectManager.HandleAccessCheckResult.DifferentAccess"> <summary> Specifies whether the access granted in the handle is different than would be granted if the resource was reopened. </summary> </member> <member name="P:NtObjectManager.HandleAccessCheckResult.ProcessId"> <summary> Process ID containing the handle. </summary> </member> <member name="P:NtObjectManager.HandleAccessCheckResult.Handle"> <summary> The handle value. </summary> </member> <member name="P:NtObjectManager.HandleAccessCheckResult.Object"> <summary> The object address. </summary> </member> <member name="T:NtObjectManager.GetAccessibleHandle"> <summary> <para type="synopsis">Get a list of accessible handles from a specified token.</para> <para type="description">This cmdlet enumerates all handles accessible from a specific token and checks and determines what the maximum access rights are for that handle.</para> </summary> <remarks>For best results this command should be run as an administrator.</remarks> <example> <code>Get-AccessibleHandle</code> <para>Check all accessible handles for the current process token.</para> </example> <example> <code>Get-AccessibleHandle -TypeFilter Key</code> <para>Check all accessible key handles for the current process token.</para> </example> <example> <code>Get-AccessibleHandle -ProcessIds 1234,5678</code> <para>>Check all accessible handles for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>Get-AccessibleHandle | Where-Object DifferentAccess</code> <para>Check all accessible handles for the current process token where the access differs from what the access would be if you reopened the resource</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleHandle.TypeFilter"> <summary> <para type="description">Specify list of NT object types to filter on.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleHandle.QueryAllDevicePaths"> <summary> <para type="description">Specify to query all file device paths. Doing this might cause the cmdlet to hang.</para> </summary> </member> <member name="T:NtObjectManager.GetAccessibleKeyCmdlet"> <summary> <para type="synopsis">Get a list of Registry Keys that can be opened by a specified token.</para> <para type="description">This cmdlet checks a registry key and tries to determine if one or more specified tokens can open them. If no tokens are specified the current process token is used.</para> </summary> <example> <code>Get-AccessibleKey \Registry\Machine\Software</code> <para>Check accessible keys \Registry\Machine\Software for the current process token.</para> </example> <example> <code>Get-AccessibleKey \Registry\Machine\Software -ProcessIds 1234,5678</code> <para>Check accessible keys \Registry\Machine\Software for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>Get-AccessibleKey \Registry\Machine\Software -Recurse</code> <para>Check recursively for accessible keys \Registry\Machine\Software for the current process token.</para> </example> <example> <code>Get-AccessibleKey \Registry\Machine\Software -Recurse -MaxDepth 5</code> <para>Check recursively for accessible keys \Registry\Machine\Software for the current process token to a maximum depth of 5.</para> </example> <example> <code>Get-AccessibleKey -Win32Path HKLM\Software -Recurse</code> <para>Check recursively for accessible keys NT path HKEY_LOCAL_MACHINE for the current process token using a Win32 path.</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleKey -Win32Path HKCU -Recurse -Tokens $token -AccessRights GenericWrite</code> <para>Get all keys with can be written to in HKEY_CURRENT_USER by a low integrity copy of current token.</para> </example> </member> <member name="M:NtObjectManager.GetAccessibleKeyCmdlet.BeginProcessing"> <summary> Override for begin processing. </summary> </member> <member name="M:NtObjectManager.GetAccessibleKeyCmdlet.ConvertWin32Path(System.String)"> <summary> Convert a Win32 Path to a Native NT path. </summary> <param name="win32_path">The win32 path to convert.</param> <returns>The native path.</returns> </member> <member name="T:NtObjectManager.GetAccessibleNamedPipeCmdlet"> <summary> <para type="synopsis">Get a list of named pipes that can be opened by a specified token.</para> <para type="description">This cmdlet checks for named pipes and tries to determine if one or more specified tokens can open them. If no tokens are specified the current process token is used.</para> </summary> <example> <code>Get-AccessibleNamedPipe</code> <para>Check accessible named pipes for the current process token.</para> </example> <example> <code>Get-AccessibleNamedPipe -OpenServer</code> <para>Check accessible named pipes server end points which can be opened for the current process token.</para> </example> <example> <code>Get-AccessibleNamedPipe -ProcessIds 1234,5678</code> <para>Check accessible named pipes for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleNamedPipes -Tokens $token -AccessRights GenericWrite</code> <para>Get all named pipes with can be written to by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleNamedPipeCmdlet.FormatWin32Path"> <summary> <para type="description">When generating the results format path in Win32 format.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleNamedPipeCmdlet.OpenServer"> <summary> <para type="description">Try and open the server end rather than the client end of the pipe.</para> </summary> </member> <member name="T:NtObjectManager.GetAccessibleObjectCmdlet"> <summary> <para type="synopsis">Get a list of NT objects that can be opened by a specified token.</para> <para type="description">This cmdlet checks a NT object key and optionally tries to determine if one or more specified tokens can open them. If no tokens are specified the current process token is used.</para> </summary> <example> <code>Get-AccessibleObject \BaseNamedObjects</code> <para>Check accessible objects under \ for the current process token.</para> </example> <example> <code>Get-AccessibleObject \BaseNamedObjects -ProcessIds 1234,5678</code> <para>Check accessible objects under \BaseNamedObjects for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>Get-AccessibleObject \BaseNamedObjects -Recurse</code> <para>Check recursively for accessible objects under \BaseNamedObjects for the current process token.</para> </example> <example> <code>Get-AccessibleObject \BaseNamedObjects -Recurse -MaxDepth 5</code> <para>Check recursively for accessible objects under \BaseNamedObjects for the current process token to a maximum depth of 5.</para> </example> <example> <code>Get-AccessibleObject -Win32Path \ -Recurse</code> <para>Check recursively for accessible objects under the user's based named objects for the current process token.</para> </example> <example> <code>Get-AccessibleObject \ -Recurse -AccessRights GenericWrite</code> <para>Check recursively for accessible objects under with write access.</para> </example> <example> <code>Get-AccessibleObject \ -Recurse -AccessRights GenericWrite -AllowPartialAccess</code> <para>Check recursively for accessible objects under with partial write access.</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleObject \BaseNamedObjects -Recurse -Tokens $token -AccessRights GenericWrite</code> <para>Get all object which can be written to in \BaseNamedObjects by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleObjectCmdlet.TypeFilter"> <summary> <para type="description">Specify list of NT object types to filter on.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleObjectCmdlet.FromHandles"> <summary> <para type="description">Specify to find objects based on handles rather than enumerating named paths.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleObjectCmdlet.CheckUnnamed"> <summary> <para type="description">Specify when enumerating handles to also check unnamed objects.</para> </summary> </member> <member name="M:NtObjectManager.GetAccessibleObjectCmdlet.ConvertWin32Path(System.String)"> <summary> Convert a Win32 Path to a Native NT path. </summary> <param name="win32_path">The win32 path to convert.</param> <returns>The native path.</returns> </member> <member name="T:NtObjectManager.ProcessAccessCheckResult"> <summary> <para type="description">Access check result for a process.</para> </summary> </member> <member name="P:NtObjectManager.ProcessAccessCheckResult.ProcessImagePath"> <summary> Process image path. </summary> </member> <member name="P:NtObjectManager.ProcessAccessCheckResult.ProcessId"> <summary> Process ID of the process. </summary> </member> <member name="P:NtObjectManager.ProcessAccessCheckResult.ProcessCommandLine"> <summary> Command line of the process. </summary> </member> <member name="P:NtObjectManager.ProcessAccessCheckResult.SessionId"> <summary> Session ID of the process. </summary> </member> <member name="P:NtObjectManager.ProcessAccessCheckResult.IsThread"> <summary> Gets whether this is a thread access check result. </summary> </member> <member name="T:NtObjectManager.ThreadAccessCheckResult"> <summary> Access check result for a thread. </summary> </member> <member name="P:NtObjectManager.ThreadAccessCheckResult.ThreadId"> <summary> Thread ID of the thread. </summary> </member> <member name="P:NtObjectManager.ThreadAccessCheckResult.ThreadDescription"> <summary> Thread description if available. </summary> </member> <member name="T:NtObjectManager.ProcessCheckMode"> <summary> <para type="description">Specify what objects to query for.</para> </summary> </member> <member name="F:NtObjectManager.ProcessCheckMode.ProcessOnly"> <summary> Only check processes </summary> </member> <member name="F:NtObjectManager.ProcessCheckMode.ThreadOnly"> <summary> Only check threads. </summary> </member> <member name="F:NtObjectManager.ProcessCheckMode.ProcessAndThread"> <summary> Check both processes and threads. </summary> </member> <member name="T:NtObjectManager.GetAccessibleProcessCmdlet"> <summary> <para type="synopsis">Get a list of processes and/or threads that can be opened by a specified token.</para> <para type="description">This cmdlet checks all processes and threads and tries to determine if one or more specified tokens can open them to them. If no tokens are specified then the current process token is used.</para> </summary> <remarks>For best results this command should be run as an administrator with SeDebugPrivilege.</remarks> <example> <code>Get-AccessibleProcess</code> <para>Check all accessible processes for the current process token.</para> </example> <example> <code>Get-AccessibleProcess -ProcessIds 1234,5678</code> <para>>Check all accessible processes for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleProcess -Tokens $token -AccessRights GenericWrite</code> <para>Get all processes with can be written by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleProcessCmdlet.CheckMode"> <summary> <para type="description">Specify what objects to check for.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleProcessCmdlet.ThreadAccessRights"> <summary> <para type="description">Specify specific access rights for threads.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleProcessCmdlet.ShowDeadProcesses"> <summary> <para type="description">Specify that dead processes should be shown.</para> </summary> </member> <member name="T:NtObjectManager.ServiceAccessCheckResult"> <summary> <para type="description">Access check result for a service.</para> </summary> </member> <member name="P:NtObjectManager.ServiceAccessCheckResult.Triggers"> <summary> Service triggers for service. </summary> </member> <member name="T:NtObjectManager.GetAccessibleServiceCmdlet"> <summary> <para type="synopsis">Get a list of services openable by a specified token.</para> <para type="description">This cmdlet checks all services and tries to determine if one or more specified tokens can open them. If no tokens are specified then the current process token is used.</para> </summary> <remarks>For best results this command should be run as an administrator.</remarks> <example> <code>Get-AccessibleService</code> <para>Check all accessible services for the current process token.</para> </example> <example> <code>Get-AccessibleService -CheckScmAccess</code> <para>Check access to the SCM for the current process token.</para> </example> <example> <code>Get-AccessibleService -ProcessIds 1234,5678</code> <para>>Check all accessible services for the process tokens of PIDs 1234 and 5678</para> </example> <example> <code>$token = Get-NtToken -Primary -Duplicate -IntegrityLevel Low
Get-AccessibleService -Tokens $token -AccessRights GenericWrite</code> <para>Get all services which can be written by a low integrity copy of current token.</para> </example> </member> <member name="P:NtObjectManager.GetAccessibleServiceCmdlet.Name"> <summary> <para type="description">Specify names of services to check.</para> </summary> </member> <member name="P:NtObjectManager.GetAccessibleServiceCmdlet.CheckScmAccess"> <summary> <para type="description">Check access to the SCM.</para> </summary> </member> <member name="T:NtObjectManager.GetNtEventCmdlet"> <summary> <para type="synopsis">Open a NT event object by path.</para> <para type="description">This cmdlet opens an existing NT event object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtEvent \BaseNamedObjects\ABC</code> <para>Get an event object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtEvent ABC -Root $root</code> <para>Get an event object with a relative path. </para> </example> <example> <code>$obj = Get-NtEvent -Path \BaseNamedObjects\ABC
$obj.Wait()</code> <para>Get an event object, wait for it to be set.</para> </example> <example> <code>$obj = Get-NtEvent -Path \BaseNamedObjects\ABC
$obj.Set()</code> <para>Get an event object, and set it.</para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtEvent ABC</code> <para>Get an event object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtEventCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtEventCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtEventCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtEventCmdlet"> <summary> <para type="synopsis">Create a new NT event object.</para> <para type="description">This cmdlet creates a new NT event object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtEvent</code> <para>Create a new anonymous event object.</para> </example> <example> <code>$obj = New-NtEvent \BaseNamedObjects\ABC</code> <para>Create a new event object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtEvent ABC -Root $root</code> <para>Create a new event object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtEvent ABC</code> <para>Create a new event object with a relative path based on the current location. </para> </example> <example> <code>$obj = New-NtEvent -InitialState $true</code> <para>Create a new anonymous event object with it initially set.</para> </example> <example> <code>$obj = New-NtEvent -Path \BaseNamedObjects\ABC
$obj.Wait()</code> <para>Create a new event object, wait for it to be set.</para> </example> <example> <code>$obj = New-NtEvent -Path \BaseNamedObjects\ABC
$obj.Set()</code> <para>Create a new event object, and set it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtEventCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtEventCmdlet.InitialState"> <summary> <para type="description">The initial state of the event object.</para> </summary> </member> <member name="P:NtObjectManager.NewNtEventCmdlet.EventType"> <summary> <para type="description">The type of event to create.</para> </summary> </member> <member name="M:NtObjectManager.NewNtEventCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtJobCmdlet"> <summary> <para type="synopsis">Open a NT job object by path.</para> <para type="description">This cmdlet opens an existing NT job object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtJob \BaseNamedObjects\ABC</code> <para>Get an job object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtJob ABC -Root $root</code> <para>Get an job object with a relative path.</para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtJob ABC</code> <para>Get a job object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtJobCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtJobCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtJobCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtJobCmdlet"> <summary> <para type="synopsis">Create a new NT job object.</para> <para type="description">This cmdlet creates a new NT job object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtJob</code> <para>Create a new anonymous job object.</para> </example> <example> <code>$obj = New-NtJob \BaseNamedObjects\ABC</code> <para>Create a new job object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtJob ABC -Root $root</code> <para>Create a new job object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtJob ABC</code> <para>Create a new job object with a relative path based on the current location. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtJobCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtJobCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtProcessCmdlet"> <summary> <para type="synopsis">Get NT processes.</para> <para type="description">This cmdlet gets all accessible processes on the system. You can specify a specific process by setting the -ProcessId or -Current parameters.</para> <para>Note that process objects need to be disposed of after use, therefore capture them in a Dispose List or manually Close them once used. You can specify some specific filters for the list of processes returned. The advantage of filtering here is the created NtProcess objects will be automatically disposed of when not needed.</para> </summary> <example> <code>$ps = Get-NtProcess</code> <para>Get all NT processes accessible by the current user.</para> </example> <example> <code>$p = Get-NtProcess -Current</code> <para>Get reference to current process.</para> </example> <example> <code>$ps = Get-NtProcess -Access DupHandle</code> <para>Get all NT processes accessible by the current user for duplicate handle access.</para> </example> <example> <code>$p = Get-NtProcess 1234</code> <para>Get a specific process</para> </example> <example> <code>$p = Get-NtProcess 1234 -Access QueryInformation
$p.CommandLine</code> <para>Get a command line of a specific process.</para> </example> <example> <code>$p = Get-NtProcess 1234 -Access QueryInformation
$p.FullPath</code> <para>Get a native image path of a specific process.</para> </example> <example> <code>$p = Get-NtProcess $pid</code> <para>Get the current process by process ID.</para> </example> <example> <code>$p = Get-NtProcess 1234 -OpenParent</code> <para>Get the parent of a specific process.</para> </example> <example> <code>$ps = Get-NtProcess -Name notepad.exe</code> <para>Get all processes with the name notepad.exe.</para> </example> <example> <code>$ps = Get-NtProcess -CommandLine hello</code> <para>Get all processes with where the command line contains the string "hello".</para> </example> <example> <code>$ps = Get-NtProcess -Name notepad.exe -CommandLine hello</code> <para>Get all processes with the name notepad.exe where the command line contains the string "hello".</para> </example> <example> <code>$ps = Get-NtProcess -FilterScript { $_.SessionId -eq 1 }</code> <para>Get all processes in session 1.</para> </example> <example> <code>$ps = Get-NtProcess -FilterScript { $_.Mitigations.DisallowWin32kSystemCalls -eq $true }</code> <para>Get all processes with the Disallow Win32k System Calls mitigation policy.</para> </example> <example> <code>$p = Get-NtProcess -ServiceName WebClient</code> <para>Open the process which hosts the WebClient service, if it's running.</para> </example> <example> <code>Get-NtProcess -InfoOnly</code> <para>Get all process information, don't open the process objects.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.ProcessId"> <summary> <para type="description">Specify a process ID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.OpenParent"> <summary> <para type="description">When opening a specific process choose whether to open its parent instead.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.OpenOwner"> <summary> <para type="description">When opening a specific process choose whether to open its owner process (which is typically a console host) instead.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.Name"> <summary> <para type="description">Specify a executable name to filter the list on.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.CommandLine"> <summary> <para type="description">Specify sub-string in the command line to filter the list on. If Name is also specified this will just select processes with that name with this sub-string.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.ServiceName"> <summary> <para type="description">Get the process for the specified service name.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.FilterScript"> <summary> <para type="description">Specify an arbitrary filter script.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.Access"> <summary> <para type="description">Specify access rights for each process opened.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.Current"> <summary> <para type="description">Open current process.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.FromSystem"> <summary> <para type="description">When getting all processes only get the system information process list.</para> </summary> </member> <member name="P:NtObjectManager.GetNtProcessCmdlet.InfoOnly"> <summary> <para type="description">Only get process information, do not open the objects.</para> </summary> </member> <member name="M:NtObjectManager.GetNtProcessCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.GetNtProcessCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetNtSectionCmdlet"> <summary> <para type="synopsis">Open a NT section object by path.</para> <para type="description">This cmdlet opens an existing NT section object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtSection \BaseNamedObjects\ABC</code> <para>Get a section object with an absolute path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtSectionCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtSectionCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtSectionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtSectionCmdlet"> <summary> <para type="synopsis">Create a new NT section object.</para> <para type="description">This cmdlet creates a new NT section object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtSection -Size 4096</code> <para>Create a new anonymous section object of size 4096 bytes.</para> </example> <example> <code>$obj = New-NtSection \BaseNamedObjects\ABC -Size 4096</code> <para>Create a new section object with an absolute path.</para> </example> <example> <code>$file = Get-NtFile \??\C:\SomeFile
$obj = New-NtSection -File $file -Protection ReadOnly</code> <para>Create a new section object backed by a file with read only protection. </para> </example> <example> <code>$file = Get-NtFile \??\C:\Windows\notepad.exe
$obj = New-NtSection -File $file -SectionAttributes Image -Protection ReadOnly</code> <para>Create a new image section object backed by an executable file. </para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtSectionCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtSectionCmdlet.File"> <summary> <para type="description">An existing file to use as backing for the section.</para> </summary> </member> <member name="P:NtObjectManager.NewNtSectionCmdlet.Size"> <summary> <para type="description">An optional size for the section.</para> </summary> </member> <member name="P:NtObjectManager.NewNtSectionCmdlet.Protection"> <summary> <para type="description">Memory allocation protection flags.</para> </summary> </member> <member name="P:NtObjectManager.NewNtSectionCmdlet.SectionAttributes"> <summary> <para type="description">Section attribute flags.</para> </summary> </member> <member name="M:NtObjectManager.NewNtSectionCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NewNtSectionCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="T:NtObjectManager.GetNtSemaphoreCmdlet"> <summary> <para type="synopsis">Open a NT semaphore object by path.</para> <para type="description">This cmdlet opens an existing NT semaphore object (also known as a mutex). The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtSemaphore \BaseNamedObjects\ABC</code> <para>Get a semaphore object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtSemaphore ABC -Root $root</code> <para>Get a semaphore object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtSemaphore ABC</code> <para>Get a semaphore object with a relative path based on the current location. </para> </example> <example> <code>$obj = Get-NtSemaphore -Path \BaseNamedObjects\ABC
$obj.Wait()
# Do something in lock...
$obj.Release()</code> <para>Get a semaphore object, acquire the lock via Wait and Release it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtSemaphoreCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtSemaphoreCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.GetNtSemaphoreCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtSemaphoreCmdlet"> <summary> <para type="synopsis">Create a new NT semaphore object.</para> <para type="description">This cmdlet creates a new NT semaphore object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtSemaphore</code> <para>Create a new anonymous semaphore object.</para> </example> <example> <code>$obj = New-NtSemaphore \BaseNamedObjects\ABC</code> <para>Create a new semaphore object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtSemaphore ABC -Root $root</code> <para>Create a new semaphore object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtSemaphore ABC</code> <para>Create a new semaphore object with a relative path based on the current location. </para> </example> <example> <code>$semaphore = New-NtSemaphore -MaximumCount 10</code> <para>Create a new anonymous semaphore object a maximum count of 10.</para> </example> <example> <code>$semaphore = New-NtSemaphore -InitialCount 1</code> <para>Create a new anonymous semaphore object the initial count set to 1.</para> </example> <example> <code>$obj = New-NtSemaphore -InitialCount 1
$semaphore.Wait(10)
# Do something with the semaphore...
$obj.Release(1)</code> <para>Create a new anonymous semaphore object with an initial count of 1, decrement the semaphore via Wait with a 10 second wait and Release it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtSemaphoreCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.NewNtSemaphoreCmdlet.InitialCount"> <summary> <para type="description">Specify the intial count of the semaphore.</para> </summary> </member> <member name="P:NtObjectManager.NewNtSemaphoreCmdlet.MaximumCount"> <summary> <para type="description">Specify the maximum count of the semaphore.</para> </summary> </member> <member name="M:NtObjectManager.NewNtSemaphoreCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtSemaphoreCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtThreadCmdlet"> <summary> <para type="synopsis">Get NT threads.</para> <para type="description">This cmdlet gets all accessible threads on the system. You can specify a specific thread by setting the -ThreadId parameter.</para> <para>Note that thread objects need to be disposed of after use, therefore capture them in a Dispose List or manually Close them once used.</para> </summary> <example> <code>$ts = Get-NtThread</code> <para>Get all NT threads accessible by the current user.</para> </example> <example> <code>$ts = Get-NtThread -Access Impersonate</code> <para>Get all NT threads accessible by the current user for impersonate access.</para> </example> <example> <code>$t = Get-NtThread 1234</code> <para>Get a specific thread.</para> </example> <example> <code>$t = Get-NtThread -ProcessId 1234</code> <para>Get threads for a specific process.</para> </example> <example> <code>$ts = Get-NtThread -Current</code> <para>Get the current NT thread.</para> </example> <example> <code>$ts = Get-NtThread -FilterScript { Use-NtObject($k = $_.OpenToken()) { $k -ne $null } }</code> <para>Get threads which have impersonation tokens set.</para> </example> <example> <code>Get-NtThread -InfoOnly</code> <para>Get all thread information, but don't open the thread objects.</para> </example> <example> <code>Get-NtThread -InfoOnly -ProcessId $pid</code> <para>Get all thread information for the current process, but don't open the thread objects.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.ThreadId"> <summary> <para type="description">Specify a thread ID to open.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.ProcessId"> <summary> <para type="description">Specify a process ID to enumerate only its threads.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.Current"> <summary> <para type="description">Get the current thread.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.PseudoHandle"> <summary> <para type="description">When getting the current thread return pseudo handle. This handle doesn't need to be closed but changes identity if used in a different thread.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.FilterScript"> <summary> <para type="description">Specify an arbitrary filter script.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.Access"> <summary> <para type="description">Specify access rights for each thread opened.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.FromSystem"> <summary> <para type="description">When getting all threads only get the system information thread list.</para> </summary> </member> <member name="P:NtObjectManager.GetNtThreadCmdlet.InfoOnly"> <summary> <para type="description">Only get thread information, do not open the objects.</para> </summary> </member> <member name="M:NtObjectManager.GetNtThreadCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.GetNtThreadCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetNtTokenCmdlet"> <summary> <para type="synopsis">Open an NT token from different sources.</para> <para type="description">This cmdlet gets a token from one of multiple possible sources. You can specify either a Primary process token, a Thread impersonation token, an Effective token, a Clipboard token, a Logon/S4U token, the anonymous token, a lowbox or a filtered token.</para> <para>Note that tokens objects need to be disposed of after use, therefore capture them in Use-NtObject or manually Close them once used.</para> </summary> <example> <code>$obj = Get-NtToken</code> <para>Get current process' primary token.</para> </example> <example> <code>$obj = Get-NtToken -Pseudo</code> <para>Get current process' pseudo primary token.</para> </example> <example> <code>$obj = Get-NtToken -Primary</code> <para>Get current process' primary token (-Primary is optional)</para> </example> <example> <code>$obj = Get-NtToken -Access Duplicate</code> <para>Get current process' primary token for Duplicate access.</para> </example> <example> <code>$obj = Get-NtToken -Duplicate -TokenType Impersonation -ImpersonationLevel Impersonation</code> <para>Get current process' primary token and convert to an impersonation token.</para> </example> <example> <code>$obj = Get-NtToken -Duplicate -TokenType Primary -IntegrityLevel Low</code> <para>Get current process token, duplicate as primary and set integrity level to Low.</para> </example> <example> <code>$obj = Get-NtTokenPrimary -Access AdjustPrivileges
$obj.SetPrivilege("SeDebugPrivilege", $true)</code> <para>Enable debug privilege on current token.</para> </example> <example> <code>$process = Get-NtProcess -ProcessId 1234
$obj = Get-NtToken -Primary -Process $process</code> <para>Get process token for a specific process.</para> </example> <example> <code>$obj = Get-NtToken -Primary -ProcessId 1234</code> <para>Get process token for a specific process by process ID.</para> </example> <example> <code>$obj = Get-NtToken -Primary
$obj.GetPrivileges()</code> <para>Query the privileges of a token.</para> </example> <example> <code>$obj = Get-NtToken -Primary
$obj.GetGroups()</code> <para>Query the groups of a token.</para> </example> <example> <code>$thread = Get-NtThread -ThreadId 1234
$obj = Get-NtToken -Impersonation -Thread $thread</code> <para>Get the impersonation token for a specific thread.</para> </example> <example> <code>$obj = Get-NtToken -Impersonation -ThreadId 1234</code> <para>Get impersonation token for a specific thread by ID.</para> </example> <example> <code>$obj = Get-NtToken -Effective -ThreadId 1234</code> <para>Get the effective token for a specific thread by ID.</para> </example> <example> <code>$obj = Get-NtToken -Clipboard</code> <para>Get the current clipboard token.</para> </example> <example> <code>$obj = Get-NtToken -Logon -User Bob -Password BobP@ssword</code> <para>Get network logon token for user Bob in the current domain with password BobP@ssword.</para> </example> <example> <code>$obj = Get-NtToken -Logon -User Bob -Password BobP@ssword -Domain BADGERS -LogonType Interactive</code> <para>Get interactive logon token for BADGERS\\Bob with password BobP@ssword.</para> </example> <example> <code>$obj = Get-NtToken -S4U -User Bob -Domain BADGERS</code> <para>Get S4U network logon token for BADGERS\\Bob with no password.</para> </example> <example> <code>$obj = Get-NtToken -Anonymous</code> <para>Get the anonymous logon token.</para> </example> <example> <code>Get-NtToken -Filtered -Flags DisableMaxPrivileges</code> <para>Get current process' primary token and disable the maximum privileges.</para> </example> <example> <code>Get-NtToken -Filtered -SidsToDisable "WD","BA"</code> <para>Get current process' primary token and set Everyone and Built Administrators groups to deny only.</para> </example> <example> <code>$token = Use-NtObject($tmp = Get-NtToken -Primary) { Get-NtToken -Filtered -Token $tmp -RestrictedSids $tmp.Groups }</code> <para>Get current process' primary token, pass it as an explicit token and add all groups as restricted SIDs.</para> </example> <example> <code>Get-NtToken -Filtered -Flags LuaToken</code> <para>Get current process' primary token and convert it to a LUA token.</para> </example> <example> <code>Get-NtToken -LowBox -PackageSid "Application.Name"</code> <para>Get current process' primary token create a lowbox token with a named package.</para> </example> <example> <code>Get-NtToken -LowBox -PackageSid "S-1-15-2-1-2-3-4-5-6-7"</code> <para>Get current process' primary token create a lowbox token with a package Sid.</para> </example> <example> <code>Get-NtToken -LowBox -PackageSid "Application.Name" -CapabilitySid "readRegistry", "S-1-15-3-1"</code> <para>Get current process' primary token create a lowbox token with a named package and the internetClient and readRegistry capabilities.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Access"> <summary> <para type="description">Specify access rights for the token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Duplicate"> <summary> <para type="description">Return a duplicated version of the token. The type of token is specified using -TokenType and -ImpersonationLevel</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.TokenType"> <summary> <para type="description">Specify the type of token to create if -Duplicate is specified.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.ImpersonationLevel"> <summary> <para type="description">Specify the impersonation level of the token to create if -Duplicate is specified and TokenType is Impersonation.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.IntegrityLevel"> <summary> <para type="description">Specify the integrity level of the token to if -Duplicate is specified.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Primary"> <summary> <para type="description">Get the primary token for a process.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Process"> <summary> <para type="description">Specify the process to open the token from. If not set will use the current process.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.ProcessId"> <summary> <para type="description">Specify the process to open the token from as a PID. Overridden by the Process parameter.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Impersonation"> <summary> <para type="description">Get an impersonation token for a thread.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Effective"> <summary> <para type="description">If thread impersonation token doesn't exist then get the primary token for the associated process. This is getting the "effective" token for the thread.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Thread"> <summary> <para type="description">Specify the thread to open the token from. If not set will use the current thread.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.ThreadId"> <summary> <para type="description">Specify the thread to open the token from by ID.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.OpenAsSelf"> <summary> <para type="description">Specify the token should be open with the process identity rather than the impersonated identity.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Pseduo"> <summary> <para type="description">Specify the token should be a pseudo token. When set you can't use the object for anything other than queries.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Clipboard"> <summary> <para type="description">Get the current clipboard token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Logon"> <summary> <para type="description">Get a logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.S4U"> <summary> <para type="description">Get an Services for User (S4U) logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.User"> <summary> <para type="description">Specify username for logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Password"> <summary> <para type="description">Specify password for logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.AdditionalGroups"> <summary> <para type="description">Specify additional group sids for logon token. Needs TCB privilege.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Domain"> <summary> <para type="description">Specify domain for logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.LogonType"> <summary> <para type="description">Specify logon type for logon token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Anonymous"> <summary> <para type="description">Get anonymous token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.LowBox"> <summary> <para type="description">Get a lowbox token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Filtered"> <summary> <para type="description">Get a filtered token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Token"> <summary> <para type="description">Specify the token to sandbox. If not specified then the current primary token is used.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.PrivilegesToDelete"> <summary> <para type="description">Specify list of privileges to delete.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.SidsToDisable"> <summary> <para type="description">Specify list group SIDS to disable.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.RestrictedSids"> <summary> <para type="description">Specify list restricted SIDS to add to token.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Flags"> <summary> <para type="description">Specify filter flags.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.PackageSid"> <summary> <para type="description">Specify package SID or a package name.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.RestrictedPackageName"> <summary> <para type="description">Specify an additional restricted name for the package SID.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.CapabilitySids"> <summary> <para type="description">Specify list of capability SIDS to add to token. Can specify an SDDL format string or a capability name.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTokenCmdlet.Handles"> <summary> <para type="description">Specify list of handles to capture with lowbox token..</para> </summary> </member> <member name="M:NtObjectManager.GetNtTokenCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.GetNtTokenCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.NewNtTokenCmdlet"> <summary> <para type="synopsis">Create a new NT token.</para> <para type="description">This cmdlet creates a new NT token kernel APIs. It needs SeCreateTokenPrivilege to succeed.</para> </summary> <example> <code>$token = New-NtToken -User "SY"</code> <para>Create a new LocalSystem token with no groups or privileges.</para> </example> <example> <code>$token = New-NtToken -User "SY" -Groups "BA","WD" -Privileges SeDebugPrivilege,SeImpersonatePrivilege</code> <para>Create a new LocalSystem token with two groups and two privileges.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.User"> <summary> <para type="description">Specify the user SID.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.Groups"> <summary> <para type="description">Specify a list of groups.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.Privileges"> <summary> <para type="description">Specify a list of groups.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.AuthenticationId"> <summary> <para type="description">Specify an authentication ID.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.TokenType"> <summary> <para type="description">Specify the token type.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.ExpirationTime"> <summary> <para type="description">Specify the token expiration time.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.DefaultAcl"> <summary> <para type="description">Specify the token's default ACL.</para> </summary> </member> <member name="P:NtObjectManager.NewNtTokenCmdlet.IntegrityLevel"> <summary> <para type="description">Specify the token's integrity level.</para> </summary> </member> <member name="M:NtObjectManager.NewNtTokenCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtTokenCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NewNtTokenCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="T:NtObjectManager.GetNtHandleCmdlet"> <summary> <para type="synopsis">Get NT handle information.</para> <para type="description">This cmdlet gets handle information for all process on the system. You can specify a specific process by setting the -ProcessId parameter.</para> <para>By default extra information about the handle will be queried. This comes at a cost and could cause the process to hang, therefore if you don't want to query pass the -NoQuery parameter.</para> </summary> <example> <code>Get-NtHandle</code> <para>Get all NT handles.</para> </example> <example> <code>Get-NtHandle 1234</code> <para>Get all NT handles filtered to a specific Process ID</para> </example> <example> <code>Get-NtHandle $pid</code> <para>Get all NT handles for the current process.</para> </example> <example> <code>Get-NtHandle 1234 -NoQuery</code> <para>Get all NT handles filtered to a specific Process ID but don't try and query information about the handle such as name.</para> </example> </member> <member name="P:NtObjectManager.GetNtHandleCmdlet.ProcessId"> <summary> <para type="description">Specify a process ID to filter handles on.</para> </summary> </member> <member name="P:NtObjectManager.GetNtHandleCmdlet.NoQuery"> <summary> <para type="description">Specify that the returned handle entries should not be queried for additional information.</para> </summary> </member> <member name="P:NtObjectManager.GetNtHandleCmdlet.ObjectTypes"> <summary> <para type="description">Specify list of object types to filter handles.</para> </summary> </member> <member name="M:NtObjectManager.GetNtHandleCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.GetNtHandleCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetNtDirectoryCmdlet"> <summary> <para type="synopsis">Open a NT object directory.</para> <para type="description">This cmdlet opens an existing NT object directory. It's possible to open a directory by its NT path, such as \Some\Path or it can also open a private namespace which isn't represented by an accessible NT path but instead uses a boundary descriptor.</para> </summary> <example> <code>$obj = Get-NtDirectory \BaseNamedObjects</code> <para>Get a directory object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtDirectory ABC -Root $root</code> <para>Get a directory object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtDirectory ABC</code> <para>Get a directory object with a relative path based on the current location. </para> </example> <example> <code>$obj = Get-NtDirectory -Path \BaseNamedObjects
$obj.Query()</code> <para>Get a directory object and query its list of entries.</para> </example> <example> <code>$obj = Get-NtDirectory -PrivateNamespaceDescriptor WD:LW@ABC</code> <para>Get a private namespace directory object with Everyone and Low Mandatory Level SIDs and name ABC.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> <para type="link">https://msdn.microsoft.com/en-us/library/windows/desktop/ms684318(v=vs.85).aspx</para> <para type="link">https://msdn.microsoft.com/en-us/library/windows/desktop/ms682121(v=vs.85).aspx</para> </member> <member name="M:NtObjectManager.GetNtDirectoryCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtDirectoryCmdlet.PrivateNamespaceDescriptor"> <summary> <para type="description">A string format of a private namespace boundary descriptor. Uses the form [SID[:SID...]@]NAME where SID is an SDDL version of a SID to add to the boundary (such as S-X-X-X or WD) and NAME is the arbitrary name. </para> </summary> </member> <member name="M:NtObjectManager.GetNtDirectoryCmdlet.ResolvePath"> <summary> Virtual method to resolve the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="M:NtObjectManager.GetNtDirectoryCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtDirectoryCmdlet"> <summary> <para type="synopsis">Create a new NT object directory by path.</para> <para type="description">This cmdlet creates a new NT object directory. It's possible to create a directory by its NT path, such as \Some\Path or it can also create a new private namespace which isn't represented by an accessible NT path but instead uses a boundary descriptor.</para> </summary> <example> <code>$obj = New-NtDirectory</code> <para>Create a new anonymous directory object.</para> </example> <example> <code>$obj = New-NtDirectory \BaseNamedObjects\ABC</code> <para>Create a new directory object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtDirectory ABC -Root $root</code> <para>Create a new directory object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtDirectory ABC</code> <para>Create a new directory object with a relative path based on the current location.</para> </example> <example> <code>$shadow = Get-NtDirectory \SomeDir
$obj = New-NtDirectory \BaseNamedObjects\ABC -ShadowDirectory $shadow</code> <para>Create a new directory object with a shadow directory. </para> </example> <example> <code>$obj = New-NtDirectory -PrivateNamespaceDescriptor WD:LW@ABC</code> <para>Create a new private namespace directory object with Everyone and Low Mandatory Level SIDs and name ABC.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> <para type="link">https://msdn.microsoft.com/en-us/library/windows/desktop/ms682419%28v=vs.85%29.aspx</para> <para type="link">https://msdn.microsoft.com/en-us/library/windows/desktop/ms682121(v=vs.85).aspx</para> </member> <member name="P:NtObjectManager.NewNtDirectoryCmdlet.ShadowDirectory"> <summary> <para type="description">Specifies another NT directory object to use as a shadown directory. This changes the lookup operation so that if an entry isn't in the created directory it will try and look it up in the shadown instead. </para> </summary> </member> <member name="P:NtObjectManager.NewNtDirectoryCmdlet.Flags"> <summary> <para type="description">Specifies flags to use when creating the directory object. </para> </summary> </member> <member name="M:NtObjectManager.NewNtDirectoryCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtDirectoryCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtDirectoryChildCmdlet"> <summary> <para type="synopsis">Get the accessible children of an object directory.</para> <para type="description">This cmdlet gets the children of a directory object. It allows the children to be extracted recursively. You can choose to get the children through the pipeline or specify a vistor script. </para> </summary> <example> <code>$ds = Get-NtDirectoryChild $dir</code> <para>Get immediate children of an object directory.</para> </example> <example> <code>$ds = Get-NtDirectoryChild $dir -Recurse</code> <para>Get children of an object directory recursively.</para> </example> <example> <code>$ds = Get-NtDirectoryChild $dir -Recurse -MaxDepth 2</code> <para>Get children of an object directory recursively up to a maximum depth of 2.</para> </example> <example> <code>$ds = Get-NtDirectoryChild $dir Access ReadControl</code> <para>Get children of an object directory which can be opened for ReadControl access.</para> </example> <example> <code>Get-NtDirectoryChild $dir -Visitor { $path = $_.FullPath; Write-Host $path }</code> <para>Get children of an object directory via the visitor pattern.</para> </example> <example> <code>Get-NtDirectoryChild $dir -Recurse -Visitor { $path = $_.FullPath; Write-Host $path; $path -notmatch "BLAH" }</code> <para>Get children of an object directory via the visitor pattern, exiting the recursion if the object path contains the string BLAH.</para> </example> <example> <code>$ds = Get-NtDirectoryChild $dir -Recurse -Filter { $_.FullPath -match "BLAH" }</code> <para>Get children of an object directory filtering out any objects which don't have BLAH in the name.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtDirectoryChildCmdlet.VisitChildObjects(System.Func{NtApiDotNet.NtDirectory,System.Boolean})"> <summary> Overridden visit method. </summary> <param name="visitor">The visitor function.</param> <returns>Returns true if visited all children.</returns> </member> <member name="T:NtObjectManager.GetNtFileCmdlet"> <summary> <para type="synopsis">Open a existing NT file object.</para> <para type="description">This cmdlet opens a existing NT file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter. To simply calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter.</para> </summary> <example> <code>$obj = Get-NtFile \??\C:\Windows\Notepad.exe</code> <para>Open a file object with an absolute path.</para> </example> <example> <code>$root = Get-NtFile \??\C:\Windows
$obj = Get-NtFile Notepad.exe -Root $root</code> <para>Open a file object with a relative path.</para> </example> <example> <code>$obj = Get-NtFile c:\Windows\Notepad.exe -Win32Path</code> <para>Open a file object with an absolute win32 path.</para> </example> <example> <code>$obj = Get-NtFile ..\..\..\Windows\Notepad.exe -Win32Path</code> <para>Open a file object with a relative win32 path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtFileCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtFileCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtFileCmdlet.DirectoryAccess"> <summary> <para type="description">Specify file access using directory access rights.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileCmdlet.ShareMode"> <summary> <para type="description">The access share mode to open the file with.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileCmdlet.Options"> <summary> <para type="description">The options to open the file with.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileCmdlet.Transaction"> <summary> <para type="description">Specify a transaction to create the file under.</para> </summary> </member> <member name="M:NtObjectManager.GetNtFileCmdlet.ResolveWin32Path(System.Management.Automation.SessionState,System.String)"> <summary> Resolve a Win32 path using current PS session state. </summary> <param name="state">The session state.</param> <param name="path">The path to resolve.</param> <returns>The resolved Win32 path.</returns> </member> <member name="M:NtObjectManager.GetNtFileCmdlet.ResolvePath"> <summary> Virtual method to resolve the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="M:NtObjectManager.GetNtFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtFileCmdlet"> <summary> <para type="synopsis">Create a new NT file object.</para> <para type="description">This cmdlet creates a new NT file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\abc.txt</code> <para>Creates a new file object with an absolute path.</para> </example> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\ABC -Directory</code> <para>Creates a new directory file object with an absolute path.</para> </example> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\abc.txt -Attributes Hidden</code> <para>Creates a new file object with an absolute path, with the hidden attribute.</para> </example> <example> <code>$root = Get-NtFile \??\C:\Windows
$obj = New-NtFile Temp\abc.txt -Root $root</code> <para>Creates a new file object with a relative path.</para> </example> <example> <code>$obj = New-NtFile c:\Windows\Temp\abc.txt -Win32Path</code> <para>Creates a new file object with an absolute win32 path.</para> </example> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\abc.txt -Disposition OpenIf</code> <para>Creates a new file object with an absolute path. If the file already exists then open it rather than failing.</para> </example> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\abc.txt -Disposition Supersede</code> <para>Creates a new file object with an absolute path. If the file already exists then replace it with the new file.</para> </example> <example> <code>$obj = New-NtFile \??\C:\Windows\Temp\abc.txt -Options SynchronousIoNonAlert -Access GenericRead,GenericWrite,Synchronize
$stm = $obj.ToStream($true)
$stm.WriteByte(1)</code> <para>Creates a new file object with an absolute path then writes data to it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtFileCmdlet.Attributes"> <summary> <para type="description">Specify the file attributes for the new file.</para> </summary> </member> <member name="P:NtObjectManager.NewNtFileCmdlet.Disposition"> <summary> <para type="description">Specify the disposition for creating the file.</para> </summary> </member> <member name="P:NtObjectManager.NewNtFileCmdlet.EaBuffer"> <summary> <para type="description">Specify an EA buffer to pass to the create file call.</para> </summary> </member> <member name="P:NtObjectManager.NewNtFileCmdlet.Directory"> <summary> <para type="description">Specify to create a directory instead of a file.</para> </summary> </member> <member name="M:NtObjectManager.NewNtFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NewNtFileCmdlet.#ctor"> <summary> Constructor </summary> </member> <member name="T:NtObjectManager.RemoveNtFileCmdlet"> <summary> <para type="synopsis">Open a existing NT file object.</para> <para type="description">This cmdlet opens a existing NT file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter. To simply calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter.</para> </summary> <example> <code>Remove-NtFile \??\C:\path\file.exe</code> <para>Delete a file object with an absolute path.</para> </example> <example> <code>$root = Get-NtFile \??\C:\path
Remove-NtFile file.exe -Root $root</code> <para>Delete a file object with a relative path.</para> </example> <example> <code>Remove-NtFile c:\path\file.exe -Win32Path</code> <para>Delete a file object with an absolute win32 path.</para> </example> <example> <code>Remove-NtFile ..\..\..\path\file.exe -Win32Path</code> <para>Delete a file object with a relative win32 path.</para> </example> <example> <code>Remove-NtFile \??\C:\path\file.exe -PosixSemantics</code> <para>Delete a file object with POSIX semantics (needs Win10 RS3+).</para> </example> <example> <code>Remove-NtFile \??\C:\path\file.exe -DeleteReparsePoint</code> <para>Delete a file reparse point rather than following the link.</para> </example> <example> <code>Remove-NtFile \??\C:\path\file.exe -ShareMode Read</code> <para>Delete a file object specifying a Read sharemode.</para> </example> </member> <member name="F:NtObjectManager.RemoveNtFileCmdlet.PosixSemantics"> <summary> <para type="description">Specify whether to delete with POSIX semantics.</para> </summary> </member> <member name="F:NtObjectManager.RemoveNtFileCmdlet.DeleteReparsePoint"> <summary> <para type="description">Specify whether to delete the reparse point or the target.</para> </summary> </member> <member name="M:NtObjectManager.RemoveNtFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> </member> <member name="T:NtObjectManager.GetNtNamedPipeFileCmdlet"> <summary> <para type="synopsis">Opens an existing NT named pipe file object.</para> <para type="description">This cmdlet opens an existing NT named pipe file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter. This only works if the caller has permission to access the pipe server object and the maximum number of instances is not exceeded.</para> </summary> <example> <code>$obj = Get-NtNamedPipeFile \??\pipe\abc</code> <para>Opens an existing file named pipe object with an absolute path.</para> </example> <example> <code>$obj = Get-NtNamedPipeFile \\.\pipe\abc -Win32Path</code> <para>Opens an existing file named pipe object with an absolute win32 path.</para> </example> <example> <code>$obj = Get-NtNamedPipeFile \??\pipe\abc -Disposition OpenIf</code> <para>Opens an existing file named pipe object with an absolute path. If the file already exists then open it rather than failing.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtNamedPipeFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.GetNtNamedPipeFileCmdlet.#ctor"> <summary> Constructor </summary> </member> <member name="T:NtObjectManager.NewNtNamedPipeFileCmdlet"> <summary> <para type="synopsis">Create a new NT named pipe file object.</para> <para type="description">This cmdlet creates a new NT named pipe file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = New-NtNamedPipeFile \??\pipe\abc</code> <para>Creates a new file named pipe object with an absolute path.</para> </example> <example> <code>$obj = New-NtNamedPipeFile \??\pipe\abc -MaximumInstances 100</code> <para>Creates a new file named pipe object with an absolute path and with a maximum of 100 instances.</para> </example> <example> <code>$obj = New-NtNamedPipeFile \??\pipe\abc -UnlimitedInstances</code> <para>Creates a new file named pipe object with an absolute path and with a unlimited maximum number of instances.</para> </example> <example> <code>$obj = New-NtNamedPipeFile \\.\pipe\abc -Win32Path</code> <para>Creates a new file named pipe object with an absolute win32 path.</para> </example> <example> <code>$obj = New-NtNamedPipeFile \??\pipe\abc -Disposition OpenIf</code> <para>Creates a new file named pipe object with an absolute path. If the file already exists then open it rather than failing.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.Disposition"> <summary> <para type="description">Specify the disposition for creating the file.</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.DefaultTimeoutMs"> <summary> <para type="description">Specify the default timeout for the pipe in MS</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.PipeType"> <summary> <para type="description">Specify the pipe type.</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.ReadMode"> <summary> <para type="description">Specify the pipe read mode.</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.CompletionMode"> <summary> <para type="description">Specify the pipe completion mode.</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.MaximumInstances"> <summary> <para type="description">Specify the maximum number of pipe instances (-1 is infinite).</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.UnlimitedInstances"> <summary> <para type="description">If specified an unlimited number of instances of this pipe can be created.</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.InputQuota"> <summary> <para type="description">Specify the pipe input quota (0 is default).</para> </summary> </member> <member name="P:NtObjectManager.NewNtNamedPipeFileCmdlet.OutputQuota"> <summary> <para type="description">Specify the pipe output quota (0 is default).</para> </summary> </member> <member name="M:NtObjectManager.NewNtNamedPipeFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NewNtNamedPipeFileCmdlet.#ctor"> <summary> Constructor </summary> </member> <member name="T:NtObjectManager.NewNtMailslotFileCmdlet"> <summary> <para type="synopsis">Create a new NT mailslot file object.</para> <para type="description">This cmdlet creates a new NT mailslot file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = New-NtMailslotFile \??\mailslot\abc</code> <para>Creates a new file mailslot object with an absolute path.</para> </example> <example> <code>$obj = New-NtMailslotFile \\.\mailslot\abc -Win32Path</code> <para>Creates a new file mailslot object with an absolute win32 path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtMailslotFileCmdlet.DefaultTimeoutMs"> <summary> <para type="description">Specify the default timeout for the mailslot in MS (-1 for no timeout)</para> </summary> </member> <member name="P:NtObjectManager.NewNtMailslotFileCmdlet.MaximumMessageSize"> <summary> <para type="description">Specify the maximum message size (0 means any size)</para> </summary> </member> <member name="P:NtObjectManager.NewNtMailslotFileCmdlet.MailslotQuota"> <summary> <para type="description">Specify the mailslot quota.</para> </summary> </member> <member name="M:NtObjectManager.NewNtMailslotFileCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NewNtMailslotFileCmdlet.#ctor"> <summary> Constructor </summary> </member> <member name="T:NtObjectManager.GetNtFileReparsePointCmdlet"> <summary> <para type="synopsis">Open and reads the reparse point buffer for file.</para> <para type="description">This cmdlet opens a existing NT file object and reads out the reparse point buffer data. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter. To simplify calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter.</para> </summary> <example> <code>$obj = Get-NtFileReparsePoint \??\C:\XYZ</code> <para>Reads the reparse point with an absolute path.</para> </example> <example> <code>$root = Get-NtFile \??\C:\
$obj = Get-NtFileReparsePoint XYZ -Root $root</code> <para>Reads the reparse point with a relative path.</para> </example> <example> <code>$obj = Get-NtFileReparsePoint C:\XYZ -Win32Path</code> <para>Reads the reparse point with an absolute win32 path.</para> </example> <example> <code>$obj = Get-NtFileReparsePoint ..\..\..\XYZ -Win32Path</code> <para>Reads the reparse point with a relative win32 path.</para> </example> </member> <member name="M:NtObjectManager.GetNtFileReparsePointCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.GetNtFileReparsePointCmdlet.Bytes"> <summary> <para type="description">Specify reading the reparse point data as a raw byte array.</para> </summary> </member> <member name="M:NtObjectManager.GetNtFileReparsePointCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.SetNtFileReparsePointCmdlet"> <summary> <para type="synopsis">Sets the reparse point buffer for file.</para> <para type="description">This cmdlet sets the reparse point buffer data for a file. The absolute path to the object in the NT object manager name space can be specified. To simplify calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter.</para> </summary> <example> <code>Set-NtFileReparsePoint \??\C:\ABC \??\C:\XYZ</code> <para>Sets the symbolic link for file \??\C:\ABC to point to \??\C:\XYZ.</para> </example> <example> <code>Set-NtFileReparsePoint \??\C:\ABC \??\C:\XYZ "BLAH BLAH"</code> <para>Sets the symbolic link for file \??\C:\ABC to point to \??\C:\XYZ with an explicit print name.</para> </example> <example> <code>Set-NtFileReparsePoint \??\C:\ABC \??\C:\XYZ -Directory</code> <para>Sets the symbolic link for directory \??\C:\ABC to point to \??\C:\XYZ.</para> </example> <example> <code>Set-NtFileReparsePoint C:\ABC ..\..\XYZ -Win32Path</code> <para>Sets the symbolic link for file C:\ABC to point to C:\XYZ using Win32 paths.</para> </example> <example> <code>Set-NtFileReparsePoint \??\C:\ABC ..\..\XYZ -Relative</code> <para>Sets the symbolic link for file \??\C:\ABC to point to ..\..\XYZ using a relative path.</para> </example> <example> <code>Set-NtFileReparsePoint \??\C:\ABC \??\C:\XYZ -MountPoint</code> <para>Sets the mount point for file \??\C:\ABC to point to \??\C:\XYZ.</para> </example> <example> <code>Set-NtFileReparsePoint \??\C:\ABC -ReparseBuffer $rp</code> <para>Sets the reparse buffer for file \??\C:\ABC using a raw reparse buffer.</para> </example> </member> <member name="M:NtObjectManager.SetNtFileReparsePointCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.MountPoint"> <summary> <para type="description">Specify creating a mount point.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.TargetPath"> <summary> <para type="description">Specify the target path for reparse point.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.PrintName"> <summary> <para type="description">Specify a print name for the reparse point.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.Relative"> <summary> <para type="description">Specify the symlink target should be a relative path.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.ReparseBuffer"> <summary> <para type="description">Specify the raw reparse point buffer.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.Bytes"> <summary> <para type="description">Specify the raw reparse point buffer as bytes.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.ExistingTag"> <summary> <para type="description">Specify an existing reparse tag to check when setting the reparse point (on RS1+).</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.ExistingGuid"> <summary> <para type="description">Specify an existing GUID to check when setting the reparse point (on RS1+).</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileReparsePointCmdlet.Flags"> <summary> <para type="description">Specify flags to use when setting the reparse point (on RS1+).</para> </summary> </member> <member name="M:NtObjectManager.SetNtFileReparsePointCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.SetNtFileHardlinkCmdlet"> <summary> <para type="synopsis">Creates a hardlink for a file.</para> <para type="description">This cmdlet creates a hard link to an existing file. The absolute path to the object in the NT object manager name space can be specified. To simplify calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter.</para> </summary> <example> <code>Set-NtFileHardlink -Path \??\C:\ABC\XYZ.TXT -LinkPath \??\C:\TEMP\ABC.TXT</code> <para>Create a hardlink for file \??\C:\ABC\XYZ.TXT as \??\C:\XYZ.</para> </example> <example> <code>Set-NtFileHardlink -Path C:\ABC\XYZ.TXT -LinkPath C:\TEMP\ABC.TXT -Win32Path</code> <para>Create a hardlink for file C:\ABC\XYZ.TXT as C:\TEMP\ABC.TXT.</para> </example> </member> <member name="P:NtObjectManager.SetNtFileHardlinkCmdlet.LinkPath"> <summary> <para type="description">Specify the path to the new link.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileHardlinkCmdlet.LinkRoot"> <summary> <para type="description">Specify a root object if TargetPath is relative.</para> </summary> </member> <member name="P:NtObjectManager.SetNtFileHardlinkCmdlet.ReplaceIfExists"> <summary> <para type="description">Specify to replace the target if it already exists.</para> </summary> </member> <member name="M:NtObjectManager.SetNtFileHardlinkCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.RemoveNtFileReparsePointCmdlet"> <summary> <para type="synopsis">Removes the reparse point buffer for file.</para> <para type="description">This cmdlet removes the reparse point buffer from an existing NT file object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter. To simplify calling it's also possible to specify the path in a Win32 format when using the -Win32Path parameter. It will return the original reparse buffer that was removed.</para> </summary> <example> <code>Remove-NtFileReparsePoint \??\C:\XYZ</code> <para>Remove the reparse point with an absolute path.</para> </example> <example> <code>$root = Get-NtFile \??\C:\
Remove-NtFileReparsePoint XYZ -Root $root</code> <para>Remove the reparse point with a relative path.</para> </example> <example> <code>Remove-NtFileReparsePoint C:\XYZ -Win32Path</code> <para>Remove the reparse point with an absolute win32 path.</para> </example> <example> <code>Remove-NtFileReparsePoint ..\..\..\XYZ -Win32Path</code> <para>Remove the reparse point with a relative win32 path.</para> </example> </member> <member name="M:NtObjectManager.RemoveNtFileReparsePointCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.RemoveNtFileReparsePointCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtFileChildCmdlet"> <summary> <para type="synopsis">Get the accessible children of a file directory.</para> <para type="description">This cmdlet gets the children of a file directory object. It allows the children to be extracted recursively. You can choose to get the children through the pipeline or specify a vistor script. </para> </summary> <example> <code>$files = Get-NtFileChild $file</code> <para>Get immediate children of a file directory.</para> </example> <example> <code>$files = Get-NtFileChild $file -Streams</code> <para>Get immediate children and any streams of a file.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse</code> <para>Get children of a file directory recursively.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse -OpenForBackup</code> <para>Get children of a file directory recursively.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse -MaxDepth 2</code> <para>Get children of a file directory recursively up to a maximum depth of 2.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse -FileMask *.txt</code> <para>Get children of a file directory recursively, only returning files which match the pattern *.txt.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse -TypeMask DirectoriesOnly</code> <para>Get children of a file directory recursively, only returning directories.</para> </example> <example> <code>$files = Get-NtFileChild $file Access ReadControl</code> <para>Get children of a file directory which can be opened for ReadControl access.</para> </example> <example> <code>Get-NtFileChild $file -Visitor { $path = $_.FullPath; Write-Host $path }</code> <para>Get children of a file directory via the visitor pattern.</para> </example> <example> <code>Get-NtFileChild $file -Recurse -Visitor { $path = $_.FullPath; Write-Host $path; $path -notmatch "BLAH" }</code> <para>Get children of a file directory via the visitor pattern, exiting the recursion if the object path contains the string BLAH.</para> </example> <example> <code>$files = Get-NtFileChild $file -Recurse -Filter { $_.FullPath -match "BLAH" }</code> <para>Get children of a file directory filtering out any objects which don't have BLAH in the name.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtFileChildCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.GetNtFileChildCmdlet.BeginProcessing"> <summary> Overridden BeginProcessing. </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.OpenForBackup"> <summary> <para type="description">Open keys for backup. Needs SeBackupPrivilege enabled.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.Streams"> <summary> <para type="description">Get named streams of files as well as children.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.DirectoryAccess"> <summary> <para type="description">Specify file access using directory access rights.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.ShareMode"> <summary> <para type="description">The access share mode to open the files with.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.FileMask"> <summary> <para type="description">Specify a filter name filter such as *.txt.</para> </summary> </member> <member name="P:NtObjectManager.GetNtFileChildCmdlet.TypeMask"> <summary> <para type="description">Specify the types of files to return.</para> </summary> </member> <member name="M:NtObjectManager.GetNtFileChildCmdlet.VisitChildObjects(System.Func{NtApiDotNet.NtFile,System.Boolean})"> <summary> Overridden visit method. </summary> <param name="visitor">The visitor function.</param> <returns>Returns true if visited all children.</returns> </member> <member name="T:NtObjectManager.GetNtKeyCmdlet"> <summary> <para type="synopsis">Open a NT key object by path.</para> <para type="description">This cmdlet opens an existing NT key object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtKey \Registry\Machine\Software</code> <para>Get a key object with an absolute path.</para> </example> <example> <code>$root = Get-NtKey \Registry\Machine
$obj = Get-NtKey Software -Root $root</code> <para>Get a key object with a relative path. </para> </example> <example> <code>$obj = Get-NtKey \Registry\Machine\Software
$obj.QueryKeys()</code> <para>Get a key object, and enumerate its subkeys</para> </example> <example> <code>$obj = Get-NtKey \Registry\Machine\Software
$obj.QueryValues()</code> <para>Get a key object, and enumerate its values</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtKeyCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtKeyCmdlet.Options"> <summary> <para type="description">Options to use when opening/creating the key.</para> </summary> </member> <member name="P:NtObjectManager.GetNtKeyCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="P:NtObjectManager.GetNtKeyCmdlet.Transaction"> <summary> <para type="description">Specify a transaction to create the key under.</para> </summary> </member> <member name="M:NtObjectManager.GetNtKeyCmdlet.ResolvePath"> <summary> Virtual method to resolve the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="M:NtObjectManager.GetNtKeyCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtKeyCmdlet"> <summary> <para type="synopsis">Create a new NT key object.</para> <para type="description">This cmdlet creates a new NT key object. The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = New-NtKey \Registry\Machine\Software\ABC</code> <para>Create a new key object with an absolute path.</para> </example> <example> <code>$obj = New-NtKey -Path \Registry\Machine\Software\ABC
$obj.SetValue("ValueName", String, "DataValue")</code> <para>Create a new event object and set a string value.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtKeyCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.AddNtKeyHiveCmdlet"> <summary> <para type="synopsis">Loads a new registry hive.</para> <para type="description">This cmdlet loads a registry hive to somewhere in the registry namespace. If the hive file doesn't exist it will be created.</para> </summary> <example> <code>$token = Get-NtTokenPrimary
$token.SetPrivilege("SeRestorePrivilege", $true)
$obj = Add-NtKey \??\C:\Windows\Temp\test.hiv \Registry\Machine\ABC</code> <para>Load a hive to a new attachment point.</para> </example> <example> <code>$obj = Add-NtKey \??\C:\Windows\Temp\test.hiv \Registry\A\ABC -LoadFlags AppKey</code> <para>Load a app hive to a new attachment point (can be done without privileges).</para> </example> <example> <code>$obj = Add-NtKey \??\C:\Windows\Temp\test.hiv \Registry\A\ABC -LoadFlags AppKey,ReadOnly</code> <para>Load a app hive to a new attachment point read-only.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.AddNtKeyHiveCmdlet.Path"> <summary> <para type="description">The path to the hive file to add.</para> </summary> </member> <member name="P:NtObjectManager.AddNtKeyHiveCmdlet.KeyPath"> <summary> <para type="description">Specifes the native path to where the hive should be loaded.</para> </summary> </member> <member name="P:NtObjectManager.AddNtKeyHiveCmdlet.LoadFlags"> <summary> <para type="description">Specifes the flags for loading the hive.</para> </summary> </member> <member name="M:NtObjectManager.AddNtKeyHiveCmdlet.ResolvePath"> <summary> Virtual method to return the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="M:NtObjectManager.AddNtKeyHiveCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.AddNtKeyHiveCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="T:NtObjectManager.RemoveKeyCmdlet"> <summary> <para type="synopsis">Unloads a registry hive.</para> <para type="description">This cmdlet unloads a registry hive in the registry namespace.</para> </summary> <example> <code>Remove-NtKey \Registry\Machine\ABC</code> <para>Unload the \Registry\Machine\ABC hive.</para> </example> <example> <code>Remove-NtKey \Registry\Machine\ABC -Flags ForceUnload</code> <para>Unload the \Registry\Machine\ABC hive, forcing the unload if necessary.</para> </example> </member> <member name="M:NtObjectManager.RemoveKeyCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.RemoveKeyCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.RemoveKeyCmdlet.ResolvePath"> <summary> Virtual method to return the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="P:NtObjectManager.RemoveKeyCmdlet.Flags"> <summary> <para type="description">Specifes the flags for unloading the hive.</para> </summary> </member> <member name="M:NtObjectManager.RemoveKeyCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>Always null.</returns> </member> <member name="T:NtObjectManager.GetNtKeyChildCmdlet"> <summary> <para type="synopsis">Get the accessible children of a key.</para> <para type="description">This cmdlet gets the children of a key object. It allows the children to be extracted recursively. You can choose to get the children through the pipeline or specify a vistor script. </para> </summary> <example> <code>$keys = Get-NtKeyChild $key</code> <para>Get immediate children of a key.</para> </example> <example> <code>$keys = Get-NtKeyChild $key -Recurse</code> <para>Get children of a key recursively.</para> </example> <example> <code>$keys = Get-NtKeyChild $key -Recurse -OpenForBackup</code> <para>Get children of a key recursively.</para> </example> <example> <code>$keys = Get-NtKeyChild $key -Recurse -MaxDepth 2</code> <para>Get children of a key recursively up to a maximum depth of 2.</para> </example> <example> <code>$keys = Get-NtKeyChild $key Access ReadControl</code> <para>Get children of a key which can be opened for ReadControl access.</para> </example> <example> <code>Get-NtKeyChild $key -Visitor { $path = $_.FullPath; Write-Host $path }</code> <para>Get children of a key via the visitor pattern.</para> </example> <example> <code>Get-NtKeyChild $key -Recurse -Visitor { $path = $_.FullPath; Write-Host $path; $path -notmatch "BLAH" }</code> <para>Get children of a key via the visitor pattern, exiting the recursion if the object path contains the string BLAH.</para> </example> <example> <code>$keys = Get-NtKeyChild $key -Recurse -Filter { $_.FullPath -match "BLAH" }</code> <para>Get children of a key filtering out any objects which don't have BLAH in the name.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtKeyChildCmdlet.BeginProcessing"> <summary> Overridden BeginProcessing. </summary> </member> <member name="P:NtObjectManager.GetNtKeyChildCmdlet.OpenForBackup"> <summary> <para type="description">Open keys for backup. Needs SeBackupPrivilege enabled.</para> </summary> </member> <member name="M:NtObjectManager.GetNtKeyChildCmdlet.VisitChildObjects(System.Func{NtApiDotNet.NtKey,System.Boolean})"> <summary> Overridden visit method. </summary> <param name="visitor">The visitor function.</param> <returns>Returns true if visited all children.</returns> </member> <member name="T:NtObjectManager.GetNtMutantCmdlet"> <summary> <para type="synopsis">Open a NT mutant object by path.</para> <para type="description">This cmdlet opens an existing NT mutant object (also known as a mutex). The absolute path to the object in the NT object manager name space must be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtMutant \BaseNamedObjects\ABC</code> <para>Get a mutant object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = Get-NtMutant ABC -Root $root</code> <para>Get a mutant object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtMutant ABC</code> <para>Get a mutant object with a relative path based on the current location. </para> </example> <example> <code>$obj = Get-NtMutant -Path \BaseNamedObjects\ABC
$obj.Wait()
# Do something in lock...
$obj.Release()</code> <para>Get a mutant object, acquire the lock via Wait and Release it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtMutantCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtMutantCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.GetNtMutantCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtMutantCmdlet"> <summary> <para type="synopsis">Create a new NT mutant object.</para> <para type="description">This cmdlet creates a new NT mutant object (also known as a mutex). The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtMutant</code> <para>Create a new anonymous mutant object.</para> </example> <example> <code>$obj = New-NtMutant \BaseNamedObjects\ABC</code> <para>Create a new mutant object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \BaseNamedObjects
$obj = New-NtMutant ABC -Root $root</code> <para>Create a new mutant object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtMutant ABC</code> <para>Create a new mutant object with a relative path based on the current location. </para> </example> <example> <code>$mutant = New-NtMutant -InitialOwner</code> <para>Create a new anonymous mutant object with the caller as the initial owner.</para> </example> <example> <code>$obj = New-NtMutant
$mutant.Wait()
# Do something in lock...
$obj.Release()</code> <para>Create a new anonymous mutant object, acquire the lock via Wait and Release it.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.NewNtMutantCmdlet.InitialOwner"> <summary> <para type="description">Specify to indicate the caller is the initial owner of the mutant.</para> </summary> </member> <member name="M:NtObjectManager.NewNtMutantCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NewNtMutantCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NtObjectBaseNoPathCmdlet"> <summary> Base object cmdlet. </summary> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdlet.ObjectAttributes"> <summary> <para type="description">Object Attribute flags used during Open/Create calls.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdlet.SecurityDescriptor"> <summary> <para type="description">Set to provide an explicit security descriptor to a newly created object.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdlet.Inherit"> <summary> <para type="description">Set to mark the new handle as inheritable. Can be used with ObjectAttributes.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdlet.Sddl"> <summary> <para type="description">Set to provide an explicit security descriptor to a newly created object in SDDL format.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdlet.SecurityQualityOfService"> <summary> <para type="description">Set to provide an explicit security quality of service when opening files/namedpipes.</para> </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.#ctor"> <summary> Base constructor. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.CreateObject(System.String,NtApiDotNet.AttributeFlags,NtApiDotNet.NtObject,NtApiDotNet.SecurityQualityOfService,NtApiDotNet.SecurityDescriptor)"> <summary> Create object from components. </summary> <param name="path">The path to the object.</param> <param name="attributes">The object attributes.</param> <param name="root">The root object.</param> <param name="security_quality_of_service">Security quality of service.</param> <param name="security_descriptor">Security descriptor.</param> <returns>The created object.</returns> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.Dispose(System.Boolean)"> <summary> Dispose object. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.Finalize"> <summary> Finalizer. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdlet.System#IDisposable#Dispose"> <summary> Dispose object. </summary> </member> <member name="T:NtObjectManager.NtObjectBaseCmdlet"> <summary> Base object cmdlet. </summary> </member> <member name="P:NtObjectManager.NtObjectBaseCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseCmdlet.Root"> <summary> <para type="description">An existing open NT object to use when Path is relative.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseCmdlet.Win32Path"> <summary> <para type="description">Use a Win32 path for lookups. For NT objects this means relative to BNO, for files means a DOS style path.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseCmdlet.CloseRoot"> <summary> <para type="description">Automatically close the Root object when this cmdlet finishes processing. Useful for pipelines.</para> </summary> </member> <member name="P:NtObjectManager.NtObjectBaseCmdlet.CreateDirectories"> <summary> <para type="description">Create any necessary NtDirectory objects to create the required object. Will return the created directories as well as the object in the output. The new object will be the first entry in the list. This doesn't work when opening an object or creating keys/files.</para> </summary> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.#ctor"> <summary> Base constructor. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.VerifyParameters"> <summary> Verify the parameters, should throw an exception if parameters are invalid. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.ResolvePath"> <summary> Virtual method to resolve the value of the Path variable. </summary> <returns>The object path.</returns> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="M:NtObjectManager.NtObjectBaseCmdlet.Dispose(System.Boolean)"> <summary> Dispose object. </summary> </member> <member name="T:NtObjectManager.NtObjectBaseNoPathCmdletWithAccess`1"> <summary> Base object cmdlet which has an access parameter. </summary> <typeparam name="T">The access enumeration type.</typeparam> </member> <member name="P:NtObjectManager.NtObjectBaseNoPathCmdletWithAccess`1.Access"> <summary> <para type="description">Specify the access rights for a new handle when creating/opening an object.</para> </summary> </member> <member name="M:NtObjectManager.NtObjectBaseNoPathCmdletWithAccess`1.#ctor"> <summary> Constructor. </summary> </member> <member name="T:NtObjectManager.NtObjectBaseCmdletWithAccess`1"> <summary> Base object cmdlet which has an access parameter. </summary> <typeparam name="T">The access enumeration type.</typeparam> </member> <member name="P:NtObjectManager.NtObjectBaseCmdletWithAccess`1.Access"> <summary> <para type="description">Specify the access rights for a new handle when creating/opening an object.</para> </summary> </member> <member name="M:NtObjectManager.NtObjectBaseCmdletWithAccess`1.#ctor"> <summary> Constructor. </summary> </member> <member name="T:NtObjectManager.GetNtObjectCmdlet"> <summary> <para type="synopsis">Open an NT object by path.</para> <para type="description">This cmdlet opens an NT object by its path. The returned object will be a type specific to the actual underlying NT type. </para> </summary> <example> <code>$obj = Get-NtObject \BaseNamedObjects\ABC</code> <para>Get a existing object with an absolute path.</para> </example> <example> <code>$obj = Get-NtObject \BaseNamedObjects -TypeName Directory</code> <para>Get a existing object with an explicit type.</para> </example> <example> <code>$obj = Get-NtObject \BaseNamedObjects
$obj = Get-NtObject ABC -Root $root</code> <para>Get an existing object with a relative path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.GetNtObjectCmdlet.TypeName"> <summary> <para type="description">The type of object will try and be determined automatically, however in cases where this isn't possible the NT type name can be specified here. This needs to be a value such as Directory, SymbolicLink, Mutant etc. </para> </summary> </member> <member name="P:NtObjectManager.GetNtObjectCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtObjectCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="M:NtObjectManager.GetNtObjectCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.UseNtObjectCmdlet"> <summary> <para type="synopsis">Use an NtObject (or list of NtObject) and automatically close the objects after use.</para> <para type="description">This cmdlet allows you to scope the use of NtObject, similar to the using statement in C#. When the script block passed to this cmdlet goes out of scope the input object is automatically disposed of, ensuring any native resources are closed to prevent leaks. </para> </summary> <example> <code>$ps = Use-NtObject (Get-NtProcess) { param ($ps); $ps | Select-Object Name, CommandLine }</code> <para>Select Name and CommandLine from a list of processes and dispose of the list afterwards.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.UseNtObjectCmdlet.InputObject"> <summary> <para type="description">Specify the input object to be disposed.</para> </summary> </member> <member name="P:NtObjectManager.UseNtObjectCmdlet.ScriptBlock"> <summary> <para type="description">Specify the script block to execute.</para> </summary> </member> <member name="M:NtObjectManager.UseNtObjectCmdlet.ProcessRecord"> <summary> Overridden process record method </summary> </member> <member name="T:NtObjectManager.NtStatusResult"> <summary> The result of an NTSTATUS code lookup. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Status"> <summary> The numeric value of the status code. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.StatusName"> <summary> The name of the status code if known. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Message"> <summary> Corresponding message text. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Win32Error"> <summary> Win32 error code. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Code"> <summary> The status code. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.CustomerCode"> <summary> True if a customer code. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Reserved"> <summary> True if reserved. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Facility"> <summary> The status facility. </summary> </member> <member name="P:NtObjectManager.NtStatusResult.Severity"> <summary> The status severity. </summary> </member> <member name="T:NtObjectManager.GetNtStatusCmdlet"> <summary> <para type="synopsis">Get known information about an NTSTATUS code.</para> <para type="description">This cmdlet looks up an NTSTATUS code and if possible prints the enumeration name, the message description and the corresponding win32 error. </para> </summary> <example> <code>Get-NtStatus</code> <para>Gets all known NTSTATUS codes defined in this library.</para> </example> <example> <code>Get-NtStatus -Status 0xc0000022</code> <para>Gets information about a specific status code.</para> </example> </member> <member name="P:NtObjectManager.GetNtStatusCmdlet.Status"> <summary> <para type="description">Specify a NTSTATUS code to retrieve.</para> </summary> </member> <member name="M:NtObjectManager.GetNtStatusCmdlet.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.CopyNtObjectCmdlet"> <summary> <para type="synopsis">Duplicate an object to a new handle. Optionally specify processes to duplicate to.</para> <para type="description">This cmdlet duplicates an object either in the same process or between processes. If you duplicate to another process the cmdlet will return a handle value rather than an object. </para> </summary> <example> <code>Copy-NtObject -Object $obj</code> <para>Duplicate an object to another in the current process with same access rights.</para> </example> <example> <code>Copy-NtObject -Object $obj -DestinationProcess $proc</code> <para>Duplicate an object to another process. If the desintation process is the current process an object is returned, otherwise a handle is returned.</para> </example> <example> <code>Copy-NtObject -Handle 1234 -SourceProcess $proc</code> <para>Duplicate an object from another process to the current process.</para> </example> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.Object"> <summary> <para type="description">Specify the object to duplicate in the current process.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.SourceHandle"> <summary> <para type="description">Specify the object to duplicate as a handle.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.SourceProcess"> <summary> <para type="description">Specify the process to duplicate from.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.DestinationProcess"> <summary> <para type="description">Specify the process to duplicate to. Defaults to current process.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.DesiredAccess"> <summary> <para type="description">The desired access for the duplication.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.NoRightsUpgrade"> <summary> <para type="description">Specify the no rights upgrade flags.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.ObjectAttributes"> <summary> <para type="description">The desired object attribute flags for the duplication.</para> </summary> </member> <member name="P:NtObjectManager.CopyNtObjectCmdlet.CloseSource"> <summary> <para type="description">Close the source handle.</para> </summary> </member> <member name="M:NtObjectManager.CopyNtObjectCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.CopyNtObjectCmdlet.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.BaseGetNtChildObjectCmdlet`2"> <summary> Base class for child object visitor. </summary> <typeparam name="O">The type of NT object.</typeparam> <typeparam name="A">The access rights type.</typeparam> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.Object"> <summary> <para type="description">Specify an object to get children from, should be a directory.</para> </summary> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.Access"> <summary> <para type="description">Specify the access when opening a child.</para> </summary> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.Recurse"> <summary> <para type="description">Get children recursively.</para> </summary> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.MaxDepth"> <summary> <para type="description">When recursing specify the maximum depth of recursion. -1 indicates no limit.</para> </summary> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.Visitor"> <summary> <para type="description">Specify a script block to run for every child. The file object will automatically be disposed once the vistor has executed. If you want to cancel enumeration return $false.</para> </summary> </member> <member name="P:NtObjectManager.BaseGetNtChildObjectCmdlet`2.Filter"> <summary> <para type="description">Specify a script block to filter child objects. Return $true to keep the object.</para> </summary> </member> <member name="M:NtObjectManager.BaseGetNtChildObjectCmdlet`2.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtObjectManager.BaseGetNtChildObjectCmdlet`2.VisitChildObjects(System.Func{`0,System.Boolean})"> <summary> Function to visit child objects. </summary> <param name="visitor">The visitor function to execute.</param> <returns>True if visited all children, false if cancelled.</returns> </member> <member name="M:NtObjectManager.BaseGetNtChildObjectCmdlet`2.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtObjectManager.GetNtTypesCmdlet"> <summary> <para type="synopsis">Get NT type information.</para> <para type="description">This cmdlet gets NT type information from the operating system. If run without parameters it'll retrieve all types. You can limit it to only one type using the -TypeName parameter. By default it will used cached versions of the type information as most of the time you don't need information such as how many objects are created, however if you want that current information specify the -CurrentStatus parameter.</para> </summary> <example> <code>Get-NtType</code> <para>Get all NT types.</para> </example> <example> <code>Get-NtType | Where-Object SecurityRequired -eq $False</code> <para>Get all NT types which don't require security.</para> </example> <example> <code>Get-NtType Directory</code> <para>Get the Directory NT type.</para> </example> <example> <code>Get-NtType Directory -CurrentStatus</code> <para>Get the Directory NT type with the current status of all information.</para> </example> </member> <member name="P:NtObjectManager.GetNtTypesCmdlet.TypeName"> <summary> <para type="description">Specify a specific NT type to retrieve.</para> </summary> </member> <member name="P:NtObjectManager.GetNtTypesCmdlet.CurrentStatus"> <summary> <para type="description">If set then will pull the latest information for the types rather than using cached data.</para> </summary> </member> <member name="M:NtObjectManager.GetNtTypesCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.GetNtSymbolicLinkCmdlet"> <summary> <para type="synopsis">Open a existing NT symbolic link object.</para> <para type="description">This cmdlet opens a existing NT symbolic link object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to open the object relative to an existing object by specified the -Root parameter.</para> </summary> <example> <code>$obj = Get-NtSymbolicLink \DosDevices\ABC</code> <para>Open a symbolic link object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \DosDevices
$obj = Get-NtSymbolicLink ABC -Root $root</code> <para>Open a symbolic link object with a relative path.</para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = Get-NtSymbolicLink ABC</code> <para>Get a symbolic link object with a relative path based on the current location.</para> </example> <example> <code>$obj = Get-NtSymbolicLink \DosDevices\ABC
$obj.Query()</code> <para>Open a symbolic link object and query its target.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtSymbolicLinkCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtSymbolicLinkCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtSymbolicLinkCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.GetNtSymbolicLinkTargetCmdlet"> <summary> <para type="synopsis">Get the target path for an existing NT symbolic link object.</para> <para type="description">This cmdlet opens a existing NT symbolic link object and queries its target path. That can be done using Get-NtSymbolicLink and the Query method but this simplifies the operation so that the object handle doesn't have to be closed.</para> </summary> <example> <code>Get-NtSymbolicLinkTarget \DosDevices\ABC</code> <para>Gets the symbolic link object target with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \DosDevices
Get-NtSymbolicLinkTarget ABC -Root $root</code> <para>Gets the symbolic link object target with a relative path.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.GetNtSymbolicLinkTargetCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.GetNtSymbolicLinkTargetCmdlet.Path"> <summary> <para type="description">The NT object manager path to the object to use.</para> </summary> </member> <member name="M:NtObjectManager.GetNtSymbolicLinkTargetCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NewNtSymbolicLinkCmdlet"> <summary> <para type="synopsis">Create a new NT symbolic link object.</para> <para type="description">This cmdlet creates a new NT symbolic link object. The absolute path to the object in the NT object manager name space can be specified. It's also possible to create the object relative to an existing object by specified the -Root parameter. If no path is specified than an unnamed object will be created which can only be duplicated by handle.</para> </summary> <example> <code>$obj = New-NtSymbolicLink -TargetPath \Symlink\Target</code> <para>Create a new anonymous symbolic link object.</para> </example> <example> <code>$obj = New-NtSymbolicLink \DosDevices\ABC \Symlink\Target</code> <para>Create a new symbolic link object with an absolute path.</para> </example> <example> <code>$root = Get-NtDirectory \DosDevices
$obj = New-NtSymbolicLink ABC \Symlink\Target -Root $root</code> <para>Create a new symbolic link object with a relative path. </para> </example> <example> <code>cd NtObject:\BaseNamedObjects
$obj = New-NtSymbolicLink ABC \Symlink\Target</code> <para>Create a new symbolic link object with a relative path based on the current location.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="M:NtObjectManager.NewNtSymbolicLinkCmdlet.CanCreateDirectories"> <summary> Determine if the cmdlet can create objects. </summary> <returns>True if objects can be created.</returns> </member> <member name="P:NtObjectManager.NewNtSymbolicLinkCmdlet.TargetPath"> <summary> <para type="description">Specify the target NT object manager path to follow if processing this symbolic link.</para> </summary> </member> <member name="M:NtObjectManager.NewNtSymbolicLinkCmdlet.CreateObject(NtApiDotNet.ObjectAttributes)"> <summary> Method to create an object from a set of object attributes. </summary> <param name="obj_attributes">The object attributes to create/open from.</param> <returns>The newly created object.</returns> </member> <member name="T:NtObjectManager.NtDirectoryEntry"> <summary> A class representing a NT object manager directory entry. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.Name"> <summary> Get the name of the entry. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.TypeName"> <summary> Get the NT type name of the entry. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.IsDirectory"> <summary> Indicates if this entry is a directory. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.IsSymbolicLink"> <summary> Indicates if this entry is a symbolic link. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.RelativePath"> <summary> The relative path from the drive base to the entry. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.SecurityDescriptor"> <summary> The security descriptor of the entry. This can be null if caller does not have permission to open the actual object. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.SymbolicLinkTarget"> <summary> The symbolic link target if IsSymbolicLink is true. Can be null if caller doesn't have permission to open the actual object. </summary> </member> <member name="P:NtObjectManager.NtDirectoryEntry.MaximumGrantedAccess"> <summary> The maximum granted access to the entry. Can be set to 0 if the caller doesn't have permission to open the actual object. </summary> </member> <member name="M:NtObjectManager.NtDirectoryEntry.ToObject(System.Boolean)"> <summary> Try and open the directory entry and return an actual NtObject handle. </summary> <param name="throw_on_error">True to throw on error.</param> <returns>The object opened.</returns> <exception cref="T:System.ArgumentException">Thrown if invalid typename.</exception> </member> <member name="M:NtObjectManager.NtDirectoryEntry.ToObject"> <summary> Try and open the directory entry and return an actual NtObject handle. </summary> <returns>The object opened.</returns> <exception cref="T:NtApiDotNet.NtException">Thrown if error opening object.</exception> <exception cref="T:System.ArgumentException">Thrown if invalid typename.</exception> </member> <member name="M:NtObjectManager.NtDirectoryEntry.ToString"> <summary> Overridden ToString method. </summary> <returns>The name of the directory entry.</returns> </member> <member name="T:NtObjectManager.NtObjectManagerProvider"> <summary> Object manager provider. </summary> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.InitializeDefaultDrives"> <summary> Overridden method to initialize default drives. </summary> <returns>The list of default drives.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.NewDrive(System.Management.Automation.PSDriveInfo)"> <summary> Overridden method to create a new drive. </summary> <param name="drive">The template drive info.</param> <returns>The new drive info.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.RemoveDrive(System.Management.Automation.PSDriveInfo)"> <summary> Overridden method to remove a drive. </summary> <param name="drive">The drive to remove.</param> <returns>The removed drive.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.IsValidPath(System.String)"> <summary> Overridden method to check if path is valid. </summary> <param name="path">The path to check.</param> <returns>True if the path is valid.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.ItemExists(System.String)"> <summary> Overriden method to check if an item exists. </summary> <param name="path">The drive path to check.</param> <returns>True if the item exists.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.IsItemContainer(System.String)"> <summary> Overidden method to check if an item is a container. </summary> <param name="path">The drive path to check.</param> <returns>True if the item is a container.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.GetChildItems(System.String,System.Boolean)"> <summary> Overridden method to get the child items of a path. </summary> <param name="path">The drive path.</param> <param name="recurse">True if the path should be enumerated recursively.</param> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.GetChildNames(System.String,System.Management.Automation.ReturnContainers)"> <summary> Overridden method to get the child item names of a path. </summary> <param name="path">The drive path.</param> <param name="returnContainers">Return containers.</param> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.GetItem(System.String)"> <summary> Overridden method to get the item from a path. </summary> <param name="path">The drive path.</param> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.ExpandPath(System.String)"> <summary> Overidden method expand a wildcard in a path. </summary> <param name="path">The drive path with wildcards.</param> <returns>The list of expanded paths.</returns> </member> <member name="M:NtObjectManager.NtObjectManagerProvider.NewItem(System.String,System.String,System.Object)"> <summary> Overridden method to create a new item. </summary> <param name="path">The drive path to create.</param> <param name="itemTypeName">The NT object type to create.</param> <param name="newItemValue">Additional item value data.</param> </member> <member name="T:NtObjectManager.GetNtWaitTimeout"> <summary> <para type="synopsis">Get a wait timeout which represents a specific time.</para> <para type="description">This cmdlet gets an NtWaitTimeout which can be passed to other calls. The timeout value is a combination of all the allowed time parameters, e.g. if you specify 1 second and 1000 milliseconds it will actually wait 2 seconds in total. Specifying -Infinite will get cause a wait to stop indefinitely.</para> </summary> <example> <code>$to = Get-NtWaitTimeout -Seconds 10</code> <para>Get a wait timeout represent 10 seconds.</para> </example> <example> <code>$to = Get-NtWaitTimeout Infinite</code> <para>Get a wait timeout representing infinity.</para> </example> </member> <member name="P:NtObjectManager.GetNtWaitTimeout.Seconds"> <summary> <para type="description">Specify a wait time in seconds.</para> </summary> </member> <member name="P:NtObjectManager.GetNtWaitTimeout.MilliSeconds"> <summary> <para type="description">Specify a wait time in milliseconds.</para> </summary> </member> <member name="P:NtObjectManager.GetNtWaitTimeout.Minutes"> <summary> <para type="description">Specify a wait time in minutes.</para> </summary> </member> <member name="P:NtObjectManager.GetNtWaitTimeout.Hours"> <summary> <para type="description">Specify a wait time in hours.</para> </summary> </member> <member name="P:NtObjectManager.GetNtWaitTimeout.Infinite"> <summary> <para type="description">Specify an infinite wait time.</para> </summary> </member> <member name="M:NtObjectManager.GetNtWaitTimeout.GetTimeout"> <summary> Get the NtWaitTimeout object. </summary> <returns>The NtWaitTime object.</returns> </member> <member name="M:NtObjectManager.GetNtWaitTimeout.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtObjectManager.StartNtWait"> <summary> <para type="synopsis">Wait on one or more NT objects to become signalled.</para> <para type="description">This cmdlet allows you to issue a wait on one or more NT objects until they become signalled. This is used for example to acquire a Mutant, decrement a Semaphore or wait for a Process to exit. The timeout value is a combination of all the allowed time parameters, e.g. if you specify 1 second and 1000 milliseconds it will actually wait 2 seconds in total. Specifying -Infinite overrides the time parameters and will wait indefinitely.</para> </summary> <example> <code>$ev = Get-NtEvent \BaseNamedObjects\ABC
Start-NtWait $ev -Seconds 10</code> <para>Get an event and wait for 10 seconds for it to be signalled.</para> </example> <example> <code>$ev = Get-NtEvent \BaseNamedObjects\ABC
$ev | Start-NtWait -Infinite</code> <para>Get an event and wait indefinitely for it to be signalled.</para> </example> <example> <code>$ev = Get-NtEvent \BaseNamedObjects\ABC
$ev | Start-NtWait -Infinite -Alertable</code> <para>Get an event and wait indefinitely for it to be signalled or alerted.</para> </example> <example> <code>$evs = @($ev1, $ev2)$
Start-NtWait $evs -WaitAll -Seconds 100</code> <para>Get a list of events and wait 100 seconds for all events to be signalled.</para> </example> <para type="link">about_ManagingNtObjectLifetime</para> </member> <member name="P:NtObjectManager.StartNtWait.Objects"> <summary> <para type="description">Specify a list of objects to wait on.</para> </summary> </member> <member name="P:NtObjectManager.StartNtWait.Alertable"> <summary> <para type="description">Specify the wait should be alertable.</para> </summary> </member> <member name="P:NtObjectManager.StartNtWait.WaitAll"> <summary> <para type="description">Specify a multiple object wait should exit only when all objects becomes signalled.</para> </summary> </member> <member name="M:NtObjectManager.StartNtWait.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> <member name="T:NtApiDotNet.GetNtSidCmdlet"> <summary> <para type="synopsis">Get a SID using various different mechanisms.</para> <para type="description">This cmdlet will create a SID object based on one of many mechanisms. For example it can parse the SDDL representation of the SID, or it can look up the account name. It can also create a SID based on a service name or integerity level. </para> </summary> <example> <code>Get-NtSid BA</code> <para>Gets the Sid for the builtin administrators group based on the SDDL form.</para> </example> <example> <code>Get-NtSid S-1-2-3-4-5</code> <para>Gets the Sid S-1-2-3-4-5 from its SDDL form.</para> </example> <example> <code>Get-NtSid -Name domain\user</code> <para>Gets the Sid for the username 'user' in domain 'domain'.</para> </example> <example> <code>Get-NtSid -Name BUILTIN\Administrators</code> <para>Gets the Sid for the the builtin administrators group.</para> </example> <example> <code>Get-NtSid -ServiceName service</code> <para>Gets the Sid for service name 'service'.</para> </example> <example> <code>Get-NtSid -IntegrityLevel Low</code> <para>Gets the Sid Low integrity level.</para> </example> <example> <code>Get-NtSid -IntegrityLevelRaw 1234</code> <para>Gets the Sid for the arbitrary integrity level 1234.</para> </example> <example> <code>Get-NtSid -PackageName some.package.name</code> <para>Gets the Sid for App Container package name 'some.package.name'.</para> </example> <example> <code>Get-NtSid -PackageName some.package.name -RestrictedPackageName restricted</code> <para>Gets the Sid for App Container package name 'some.package.name' with the restricted name 'restricted'</para> </example> <example> <code>Get-NtSid -KnownSid BuiltinAdministrators</code> <para>Gets the Sid for the builtin administrators group.</para> </example> <example> <code>Get-NtSid -Token</code> <para>Gets the Sid for the current user.</para> </example> <example> <code>Get-NtSid -Token -LogonGroup</code> <para>Gets the Sid for the current default logon group.</para> </example> <example> <code>Get-NtSid -CapabilityName internetClient</code> <para>Gets the capability Sid the internetClient capability.</para> </example> <example> <code>Get-NtSid -CapabilityName internetClient -CapabilityGroup</code> <para>Gets the capability group Sid the internetClient capability.</para> </example> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.Sddl"> <summary> <para type="description">Specify a SID using an SDDL string.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.Name"> <summary> <para type="description">Lookup a SID using an NT account name.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.ServiceName"> <summary> <para type="description">Create a SID based on a service name.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.IntegrityLevel"> <summary> <para type="description">Create a SID based on the standard set of integrity levels.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.IntegrityLevelRaw"> <summary> <para type="description">Create a SID based on a raw integerity level.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.PackageName"> <summary> <para type="description">Create a SID from App Container package name.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.RestrictedPackageName"> <summary> <para type="description">Specify an additional restricted name for the package SID.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.KnownSid"> <summary> <para type="description">Get a known SID.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.Token"> <summary> <para type="description">Get the SID from the current user token. Defaults to the user SID.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.Owner"> <summary> <para type="description">Get the SID for the current default owner.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.PrimaryGroup"> <summary> <para type="description">Get the SID for the current default group.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.LogonGroup"> <summary> <para type="description">Get the SID for the current login group.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.AppContainer"> <summary> <para type="description">Get the SID for the current package (if an App Container token).</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.Label"> <summary> <para type="description">Get the SID for the current integrity level.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.CapabilityName"> <summary> <para type="description">Create a SID from App Container capability name.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.CapabilityGroup"> <summary> <para type="description">Returns the group capability SID rather than normal capability SID.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.SecurityAuthority"> <summary> <para type="description">Specify a SIDs security authority.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtSidCmdlet.RelativeIdentifiers"> <summary> <para type="description">Specify the relative identifiers.</para> </summary> </member> <member name="M:NtApiDotNet.GetNtSidCmdlet.ProcessRecord"> <summary> Process record. </summary> </member> <member name="T:NtApiDotNet.SpecificAccessType"> <summary> <para type="description">Enumeration for specific access type mapping.</para> </summary> </member> <member name="T:NtApiDotNet.GetNtAccessMaskCmdlet"> <summary> <para type="synopsis">Convert a specific object access to an AccessMask or GenericAccess.</para> <para type="description">This cmdlet allows you to convert a specific object access to an AccessMask or GenericAccess for use in general functions.</para> </summary> <example> <code>Get-NtAccessMask -ProcessAccess DupHandle</code> <para>Get the Process DupHandle access right as an AccessMask</para> </example> <example> <code>Get-NtAccessMask -ProcessAccess DupHandle -ToGenericAccess</code> <para>Get the Process DupHandle access right as a GenericAccess value</para> </example> <example> <code>Get-NtAccessMask -AccessMask 0xFF -ToSpecificAccess Process</code> <para>Convert a raw access mask to a process access mask.</para> </example> <example> <code>Get-NtAccessMask -AccessControlEntry $sd.Dacl[0] -ToSpecificAccess Thread</code> <para>Get the access mask from a security descriptor ACE and map to thread access.</para> </example> <example> <code>$sd.Dacl | Get-NtAccessMask -ToSpecificAccess Thread</code> <para>Get the access mask from a list of security descriptor ACEs and map to thread access.</para> </example> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.AccessMask"> <summary> <para type="description">Specify a raw access mask.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.FileAccess"> <summary> <para type="description">Specify File access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.FileDirectoryAccess"> <summary> <para type="description">Specify File Directory access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.IoCompletionAccess"> <summary> <para type="description">Specify IO Completion access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.MutantAccess"> <summary> <para type="description">Specify Mutant access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.SemaphoreAccess"> <summary> <para type="description">Specify Semaphore access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.RegistryTransactionAccess"> <summary> <para type="description">Specify Registry Transaction access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.AlpcPortAccess"> <summary> <para type="description">Specify ALPC Port access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.SectionAccess"> <summary> <para type="description">Specify Section access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.KeyAccess"> <summary> <para type="description">Specify Key access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.EventAccess"> <summary> <para type="description">Specify Event access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.SymbolicLinkAccess"> <summary> <para type="description">Specify Symbolic Link access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.TokenAccess"> <summary> <para type="description">Specify Token access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.GenericAccess"> <summary> <para type="description">Specify Generic access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.DirectoryAccess"> <summary> <para type="description">Specify Directory access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ThreadAccess"> <summary> <para type="description">Specify Thread access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.DebugObjectAccess"> <summary> <para type="description">Specify Debug Object access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.JobAccess"> <summary> <para type="description">Specify Job access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ProcessAccess"> <summary> <para type="description">Specify Process access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.TransactionAccess"> <summary> <para type="description">Specify transaction access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.TransactionManagerAccess"> <summary> <para type="description">Specify transaction manager access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ResourceManagerAccess"> <summary> <para type="description">Specify resource manager access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.EnlistmentAccess"> <summary> <para type="description">Specify enlistment access rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ManadatoryLabelPolicy"> <summary> <para type="description">Specify mandatory label policy.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.AccessControlEntry"> <summary> <para type="description">Specify an ACE to extract the mask to map.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ToGenericAccess"> <summary> <para type="description">Return access as GenericAccess.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ToMandatoryLabelPolicy"> <summary> <para type="description">Return access as ManadatoryLabelPolicy.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ToSpecificAccess"> <summary> <para type="description">Return access as specific access type based on the NtType.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.ToTypeAccess"> <summary> <para type="description">Return access as specific access type based on the NtType object.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtAccessMaskCmdlet.MapGenericRights"> <summary> <para type="description">Specify that any generic rights should be mapped to type specific rights.</para> </summary> </member> <member name="M:NtApiDotNet.GetNtAccessMaskCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtApiDotNet.GetNtAccessMaskCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord </summary> </member> <member name="T:NtApiDotNet.GetNtGrantedAccessCmdlet"> <summary> <para type="synopsis">Gets the granted access to a security descriptor or object.</para> <para type="description">This cmdlet allows you to determine the granted access to a particular resource through a security descriptor or a reference to an object.</para> </summary> <example> <code>Get-NtGrantedAccess $sd -Type $(Get-NtType File)</code> <para>Get the maximum access for a security descriptor for a file object.</para> </example> <example> <code>Get-NtGrantedAccess -Sddl "O:BAG:BAD:(A;;GA;;;WD)" -Type $(Get-NtType Process)</code> <para>Get the maximum access for a security descriptor for a process object based on an SDDL string.</para> </example> <example> <code>Get-NtGrantedAccess -Object $obj</code> <para>Get the maximum access for a security descriptor for an object.</para> </example> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.SecurityDescriptor"> <summary> <para type="description">Specify a security descriptor.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.Sddl"> <summary> <para type="description">Specify a security descriptor in SDDL format.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.Type"> <summary> <para type="description">Specify the NT type for the access check.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.AccessMask"> <summary> <para type="description">Specify an access mask to check against. If not specified will request maximum access.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.Object"> <summary> <para type="description">Specify a kernel object to get security descriptor from.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.Token"> <summary> <para type="description">Specify a token object to do the access check against. If not specified then current token is used.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.MapToGeneric"> <summary> <para type="description">Specify whether to map the access mask back to generic rights.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.ConvertToString"> <summary> <para type="description">Specify whether to return a string rather than an enumeration value.</para> </summary> </member> <member name="P:NtApiDotNet.GetNtGrantedAccessCmdlet.Principal"> <summary> <para type="description">Specify a principal SID to user when checking security descriptors with SELF SID.</para> </summary> </member> <member name="M:NtApiDotNet.GetNtGrantedAccessCmdlet.#ctor"> <summary> Constructor. </summary> </member> <member name="M:NtApiDotNet.GetNtGrantedAccessCmdlet.ProcessRecord"> <summary> Overridden process record method. </summary> </member> <member name="T:NtApiDotNet.NewNtSecurityDescriptorCmdlet"> <summary> <para type="synopsis">Create a new security descriptor which can be used on NT objects.</para> <para type="description">This cmdlet creates a new instance of a SecurityDescriptor object. This can be used directly with one of the New-Nt* cmdlets (via the -SecurityDescriptor parameter) or by calling SetSecurityDescriptor on an existing object (assume the object has been opened with the correct permissions. </para> </summary> <example> <code>$sd = New-NtSecurityDescriptor</code> <para>Create a new empty security descriptor object.</para> </example> <example> <code>$sd = New-NtSecurityDescriptor "O:BAG:BAD:(A;;GA;;;WD)"</code> <para>Create a new security descriptor object from an SDDL string</para> </example> <example> <code>$sd = New-NtSecurityDescriptor -NullDacl</code> <para>Create a new security descriptor object with a NULL DACL.</para> </example> <example> <code>$sd = New-NtSecurityDescriptor "D:(A;;GA;;;WD)"
$obj = New-NtDirectory \BaseNamedObjects\ABC -SecurityDescriptor $sd</code> <para>Create a new object directory with an explicit security descriptor.</para> </example> <example> <code>$sd = New-NtSecurityDescriptor -Key $key -ValueName SD</code> <para>Create a new security descriptor with the contents from the key $Key and value "SD".</para> </example> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.NullDacl"> <summary> <para type="description">Specify to create the security descriptor with a NULL DACL.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.Sddl"> <summary> <para type="description">Specify to create the security descriptor from an SDDL representation.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.Token"> <summary> <para type="description">Specify to create the security descriptor from the default DACL of a token object.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.MapType"> <summary> <para type="description">Specify an NT type to map generic accesses.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.Bytes"> <summary> <para type="description">Specify a byte array containing the security descriptor.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.Key"> <summary> <para type="description">Specify a registry key to read the security descriptor from.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.ValueName"> <summary> <para type="description">Specify a registry value name in the key to read the security descriptor from.</para> </summary> </member> <member name="P:NtApiDotNet.NewNtSecurityDescriptorCmdlet.KeyValue"> <summary> <para type="description">Specify a registry key value to read the security descriptor from.</para> </summary> </member> <member name="M:NtApiDotNet.NewNtSecurityDescriptorCmdlet.ProcessRecord"> <summary> Overridden ProcessRecord method. </summary> </member> </members> </doc> |