Export-QResourceAccess
Exports the security information on a selected resource to a .CSV file.
TIP: This cmdlet is used with the Get-QResourceAccess cmdlet that generates the results to be exported.
Syntax:
Export-QResourceAccess [-ResourceAccessResults] <QAM.Common.Interfaces.ResourceAccessQueryResults> [-OutputPath] <String> [[-DisplayInheritedSecurity] [<SwitchParameter>]] [[-OptimizeForExcel] [<SwitchParameter>]] [<CommonParameters>]
Table 206: Parameters
| ResourceAccessResults |
Specify the results of a resource access query (Get-QResourceAccess). |
| OutputPath |
Specify the path to the location on disk where the access results is to be written. |
| DisplayInheritedSecurity |
(Optional) Specify this parameter if child objects with security exactly the same as the parent should be shown.
-
If the parameter is specified without a value, set to $true and show child objects.
-
If the parameter is not specified, set to $false and do not show child objects. |
| OptimizedForExcel |
(Optional) Specify this parameter if you want to export the output to Microsoft Excel.
-
If the parameter is specified without a value, set to $true and export to Excel.
-
If the parameter is not specified, set to $false and do not export to Excel. |
Examples:
Table 207: Examples
|
C:\PS># get host id
Get-QManagedHost
# get the access for the resource
$resourceAccess = Get-QResourceAccess -ManagedHostId 5b3e4a3c-9c7b-4da1-b6bc-db552ee51656 -ResourceType NTFS\Folder -Resources "C:\Test Data"
# export the results
Export-QResourceAccess -ResourceAccessResults $resourceAccess -OutputPath "C:\" |
Exports the results of a resource access query. |
Get-QChildResources
Retrieves the resources contained in a specify root on a managed host. You can use this information to enumerate the contents of remote folders and shares.
Note: The cmdlet is similar to the standard Windows PowerShell Get-ChildItems cmdlet, but it functions using the Data Governance server as a proxy. Therefore, the client machine does not require direct access to the target machine.
Syntax:
Get-QChildResources [-ManagedHostId] <String> [-ResourcePath] <String> [[-ResType] [QAM.Client.PowerShell.GetChildResourcesCmdlet+QueryResourceType]] [<CommonParameters>]
Table 208: Parameters
| ManagedHostId |
Specify the ID (GUID format) of the managed host to be queried.
Run the Get-QManagedHosts cmdlet without any parameters to retrieve a list of available managed hosts and their IDs. |
| ResourcePath |
Specify the path to the root resource. |
| ResType |
(Optional) Specify the type of resource to be located. Available types include:
- CloudFiles
- CloudFolders
- Files
- Folders
- Shares
- LocalOSRights
- AdminRights
- ServiceIdentities
- SharePoint
If this parameter is not specified, all resource types are returned. |
Examples:
Table 209: Examples
| Get-QChildResources -ManagedHostId 5b3e4a3c-9c7b-4da1-b6bc-db552ee51656 -ResourceId "\\2k8rdjsql\Test Data" -ResType Folders |
Retrieves a list of the child resources on the specified managed host. |
Details retrieved:
Table 210: Details retrieved
| Path |
The full path of the child resource. |
| DuGPath |
The path used for data under governance operations.
This will always be empty when shown from the cmdlet; however, it is used elsewhere in the application. |
| ManagedHostId |
The value (GUID) assigned to the managed host where the resource is located. |
| ResourceType |
The type of child resource. |
| Properties |
The properties of the child resource (such as name, date last modified, file size).
These are the properties you see in the Resource browser. |
Get-QFileSystemSearchResults
Search an NTFS folder or share for files. Using this command, you can search multiple data roots at once.
Syntax:
Get-QFileSystemSearchResults [-SearchRoots] <String[]> [-SearchTerm] <String> [[-ItemsRequested] [<Int32>]] [<CommonParameters>]
Table 211: Parameters
| SearchRoots |
Specify a string array of NTFS roots to search. |
| SearchTerm |
Specify the string that contains the search term.
You can use the * wildcard character to search for resources. For example, enter Finance* to return all resources with a name that begins with Finance, *.txt to return all resources that end with .txt, and *Fin* to return all resources that contain "Fin". |
| ItemsRequested |
(Optional) Specify the number of items you would like returned. |
Examples:
Table 212: Examples
| Get-QFileSystemSearchResults -SearchRoots "\\2K8R2DJSQL\C$\Test Data" -SearchTerm "*.txt" |
Finds files with the .txt extension in the specified directory. |
Details retrieved:
The following details are returned for each file system resource found in the specified directory that matched the specified search term.
Table 213: Details retrieved
| Path |
The full path of the file system resource. |
| DuGPath |
The path used for data under governance operations.
This will always be empty when shown from the cmdlet; however, it is used elsewhere in the application. |
| ManageHostId |
The ID (GUID format) of the managed host where the file system resource resides. |
| ResourceType |
The type of resource. |
| Properties |
Properties assigned to the file system resources (such as Attributes, Reserved, FileSize, LastModified).
These are the properties you see in the Resource browser. |
Get-QHostResourceActivities
Returns a list of the resource IDs associated with operations performed against a managed host during a given time frame.
Note: This PowerShell cmdlet does not support Cloud managed hosts.
Syntax:
Get-QHostResourceActivities [[-ManagedHostId] [<String>]] [[-StartTime] [<DateTime>]] [[-EndTime] [DateTime>]] [[-HostType] [<String>]] [<CommonParameters>]
Table 214: Parameters
| ManagedHostId |
(Optional) Specify the ID (GUID format) of the managed host to be retrieved.
Run the Get-QManagedHosts cmdlet without any parameters to retrieve a list of managed hosts and associated IDs. |
| StartTime |
(Optional) Specify the start date and time, which means you will only see activity information from that time forward.
Specify the start time in (UTC) form: "23/01/2015 10:36:30 PM" |
| EndTime |
(Optional) Specify the end date and time, which means you will only see activity information before that time.
Specify the end time in (UTC) form: "23/01/2015 10:37:30 PM" |
| HostType |
(Optional) Specify the type of host to be included in the results:
- WindowsServer
- OnTapDevice
- CelerraDevice
- SharePointFarm
- DistributedFileSystemRoot
- IsilonDevice
- IsilonNfsDevice
- OnTapNfsDevice
- OnTapClusterNtfsDevice
- OnTapClusterCifsDevice
When no host type is specified, all host types are included in the results.
NOTE: Resource activity collection is not available for Windows Cluster/Remote Windows or Generic host types. |
Examples:
Table 215: Examples
| Get-QHostResourceActivities |
Returns a list of all activity and associated resource IDs for all activity found in the resource activity database. |
| Get-QHostResourceActivities -ManagedHostId "c0bc3da4-f660-4e18-8b14-a945c7a6be69" |
Returns a list of all activity and associated resource IDs for all host types on the specified managed hosts. |
| Get-QHostResourceActivities -ManagedHostId "c0bc3da4-f660-4e18-8b14-a945c7a6be69" -HostType "WindowsServer" |
Returns activity information on the specified managed host, including only operations against Windows Servers. |
Details retrieved:
For each operation performed, the following details are returned:
Table 216: Details retrieved
| NodeId |
The ID used to link the activity database to the QAMNode table. (AuditNodeId in QAMNode table.) |
| ManagedHostId |
The ID (GUID) of the managed host reporting the operation. |
| ManagedHostName |
The name of the managed host reporting the operation. |
| ResourceId |
The ID assigned to the operation that was performed. |
| ParentResourceId |
Shows which resource in the activity database is the parent. |
| ResourcePath |
For file system resources, the full path of the resource |
| SharePointPath |
For SharePoint resources, the full path of the resource |
| TypeResource |
The type of resource. |
| Operation |
The type of operation that was performed against the resource:
- Create
- Delete
- Read
- Rename
- Security change
- Write
|
| StartTime |
The start date and time for collecting resource activity. Activity is stored in 'time spans'. |
| EndTime |
The end date and time for collecting resource activity. Activity is stored in 'time spans'. |
| TrusteeType |
The type of account that initiated the operation. |
| TrusteeName |
The name of the user who initiated the operation. |
| TrusteeSid |
The security identifier (SID) of the user who initiated the operation. |
| AuditTrusteeId |
The ID associated with the account that performed the operation. (UID_QAMTrustee in QAMTrustee table.) |
| AccessCount |
The number of times the operation occurred during the aggregation interval. |
