en-US/Tenable.Tools-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioAsset</command:name> <command:verb>Get</command:verb> <command:noun>TioAsset</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Assets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Assets.</maml:para> <maml:para>When querying a single asset by Asset UUID, returns all properties of the asset. When querying in other ways, a subset of the asset properties is returned.</maml:para> <maml:para>When no criteria (Uuid, Hostname or IPv4) are supplied, returns the first 5000 assets. _Note:_ If your environment has more than 5000 assets, use the Get-TioExportAsset function to filter or access all assets. When working with the asset list capability, this function will only return the first 5000 assets. There is currently no documented pagination control or filtering for this API Endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by asset UUID, returns all details.</maml:para> <maml:para>Alias: Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Hostname</maml:name> <maml:description> <maml:para>Optional. Search by asset HostName. Returns subset of details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IPv4</maml:name> <maml:description> <maml:para>Optional. Search by asset IPv4 Address. Returns subset of details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>List of Assets</maml:name> </dev:type> <maml:description> <maml:para>Optional. Either a bare list of Asset UUIDs, or a list of assets from a previous call to either Get-TioAsset or Get-TioExportAsset.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object Subset of details</maml:name> </dev:type> <maml:description> <maml:para>Object containing subset of details about the asset, unless queried by UUID.</maml:para> <maml:para>id : ad082ebc-e375-4250-93b3-ded6dd2757ab has_agent : False last_seen : 14/09/2021 23:36:13 last_scan_target : 192.168.10.10 sources : {@{name=NESSUS_SCAN; first_seen=02/09/2020 21:24:44; last_seen=14/09/2021 23:36:13}} ipv4 : {192.168.10.10} ipv6 : {} fqdn : {hostname.domain.com} netbios_name : {HOSTNAME} operating_system : {Microsoft Windows Server 2016 Standard} hostname : {hostname} agent_name : {} aws_ec2_name : {} security_protection_level : security_protections : {} exposure_confidence_value : mac_address : {}</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Object Full details</maml:name> </dev:type> <maml:description> <maml:para>id : ad082ebc-e375-4250-93b3-ded6dd2757ab has_agent : False created_at : 02/09/2020 21:28:07 updated_at : 14/09/2021 23:37:39 first_seen : 02/09/2020 21:24:44 last_seen : 14/09/2021 23:36:13 last_scan_target : 10.103.58.134 last_authenticated_scan_date : 14/09/2021 23:36:13 last_licensed_scan_date : 14/09/2021 23:36:13 last_scan_id : ad082ebc-e375-4250-93b3-ded6dd2757ac last_schedule_id : template-3356eeaf-4db9-ff3f-aba5-2a8389b6a70c9788501811d6e056 sources : {@{name=NESSUS_SCAN; first_seen=02/09/2020 21:24:44; last_seen=14/09/2021 23:36:13}} tags : {@{tag_uuid=d64191d3-3748-42f0-b742-8fbbc6646b2b; tag_key=Windows OS - Servers; tag_value=Windows Server 2016; added_by=58d31fc5-4158-418d-b199-9809cd0833eb; added_at=29/03/2021 05:36:54}, @{tag_uuid=833f5e8f-5ef2-427a-9f75-20c6d3b93bdf; tag_key=Windows Server only- Reporting; tag_value=Windows - Reporting; added_by=58d31fc5-4158-418d-b199-9809cd0833eb; added_at=22/03/2021 08:10:31}, @{tag_uuid=2311a3d5-0d63-4b3b-8dfe-92096e21b4fc; tag_key=Windows Production Server; tag_value=Site A Virtual; added_by=494d456e-0752-4b5d-b256-8ee08a1d14ba; added_at=23/09/2020 20:50:59}} interfaces : {@{name=3; aliased=False; fqdn=System.Object[]; mac_address=System.Object[]; ipv4=System.Object[]; ipv6=System.Object[]}, @{name=UNKNOWN; fqdn=System.Object[]; mac_address=System.Object[]; ipv4=System.Object[]; ipv6=System.Object[]}} network_id : {00000000-0000-0000-0000-000000000000} ipv4 : {192.168.10.10} ipv6 : {} fqdn : {hostname.domain.com} mac_address : {00:12:34:56:78:9a} netbios_name : {HOSTNAME} operating_system : {Microsoft Windows Server 2016 Standard} system_type : {general-purpose} tenable_uuid : {53ede5d70fe3464081846851a2cb372e} hostname : {hostname} agent_name : {} bios_uuid : {ad082ebc-e375-4250-93b3-ded6dd2757ad} aws_ec2_instance_id : {} aws_ec2_instance_ami_id : {} aws_owner_id : {} aws_availability_zone : {} aws_region : {} aws_vpc_id : {} aws_ec2_instance_group_name : {} aws_ec2_instance_state_name : {} aws_ec2_instance_type : {} aws_subnet_id : {} aws_ec2_product_code : {} aws_ec2_name : {} azure_vm_id : {} azure_resource_id : {} gcp_project_id : {} gcp_zone : {} gcp_instance_id : {} ssh_fingerprint : {} mcafee_epo_guid : {} mcafee_epo_agent_guid : {} qualys_asset_id : {} qualys_host_id : {} servicenow_sysid : {} installed_software : {cpe:/a:microsoft:.net_framework:2.0.50727, cpe:/a:microsoft:.net_framework:3.0…} bigfix_asset_id : {} security_protection_level : security_protections : {} exposure_confidence_value :</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>In Tenable.io, assets are defined as network entities that potentially represent security risks. Assets can include laptops, desktops, servers, routers, mobile phones, virtual machines, software containers, and cloud instances. Tenable.io allows you to track assets that belong to your organization, helping to eliminate potential security risks, identify under-utilized resources, and support compliance efforts.</maml:para> <maml:para>Use the API to list assets, get individual asset information, import assets, and list and check the status of asset import jobs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List up to 5000 Assets</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys -Uuid ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get all available details for the asset with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys -HostName 'host.domain.com'</dev:code> <dev:remarks> <maml:para>Get subset of details (from the first 5000 assets returned) for a host named host.domain.com .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys -IPv4 '192.168.10.10'</dev:code> <dev:remarks> <maml:para>Get subset of details (from the first 5000 assets returned) for a host with IPv4 Address 192.168.10.10 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys -HostName 'host.domain.com' | Get-TioAsset -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>Get all details (from the first 5000 assets returned) for a host named host.domain.com by pipelining the initial result into the function. The id or uuid property will be used as the pipeline parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > 'ad082ebc-e375-4250-93b3-ded6dd2757ab' | Get-TioAsset -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>Get all details (from the first 5000 assets returned) for a host with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab by pipelining the initial result into the function. The pipeline value will be used as the Uuid parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Assets</maml:linkText> <maml:uri>https://developer.tenable.com/reference#assets</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioExportAsset</command:name> <command:verb>Get</command:verb> <command:noun>TioExportAsset</command:noun> <maml:description> <maml:para>Get results of Asset Export request for the specified Chunk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Initiate a new export request and retrieve results, or get results of a previous Asset Export Request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioExportAsset</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Asset Export Request UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>PSObject containing Filter parameters with which to initiate the search. Refer to the Tenabe Developer reference linked below for details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TagCategory</maml:name> <maml:description> <maml:para>Tag Category to use in a search filter. Must also supply TagValue.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TagValue</maml:name> <maml:description> <maml:para>Tag Value to use in a search filter. Must also supply TagCategory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Collection of System.Object</maml:name> </dev:type> <maml:description> <maml:para>Collection of Objects containing Assets matching search criteria.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Exports all assets that match the request criteria.</maml:para> <maml:para>For using the Filter option, please refer to the referenced Tenable Developer API Reference beloe.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioExportAsset -ApiKeys $TioApiKeys -Uuid 'ad082ebc-e375-4250-93b3-ded6dd2757ab'</dev:code> <dev:remarks> <maml:para>Retrieve results of a previous asset export request with UUID of ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> <maml:para>Use `Get-TioExportAssetStatus -ApiKeys $TioApiKeys` to get a list of available, recent, asset export requests.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioExportAsset -ApiKeys $TioApiKeys -TagCategory 'Windows Server' -TagValue 'Physical'</dev:code> <dev:remarks> <maml:para>Initiate a new Asset Export using a Tag Filter for Category Windows Server and Value Physical .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > $Filter = @{} PS > $Filter.Add('is_licensed',$true) PS > Get-TioExportAsset -ApiKeys $TioApiKeys -Filter $Filter</dev:code> <dev:remarks> <maml:para>Initiate a new Asset Export using a Specified Filter. This filter returns only assets that are included in the asset count for the Tenable.io instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Export Asset Request</maml:linkText> <maml:uri>https://developer.tenable.com/reference#exports-assets-request-export</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioExportAssetChunk</command:name> <command:verb>Get</command:verb> <command:noun>TioExportAssetChunk</command:noun> <maml:description> <maml:para>Get results of Asset Export request for the specified Chunk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get results of Asset Export Request for the specfied Chunk. Results may be contained in multiple chunks, each chunk must be separately retrieved.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioExportAssetChunk</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Asset Export Request UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Chunk</maml:name> <maml:description> <maml:para>ID of chunk of results to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Collection of System.Object</maml:name> </dev:type> <maml:description> <maml:para>Collection of Objects containing Assets matching search criteria.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Downloads exported assets chunk by ID. Chunks are available for download for up to 24 hours after they have been created. Tenable.io returns a 404 message for expired chunks.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioExportAssetChunk -ApiKeys $TioApiKeys -Uuid 'ad082ebc-e375-4250-93b3-ded6dd2757ab' -Chunk 1</dev:code> <dev:remarks> <maml:para>Retrieve results of the specified asset export chunk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Download Assets Chunk</maml:linkText> <maml:uri>https://developer.tenable.com/reference#exports-assets-download-chunk</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioExportAssetStatus</command:name> <command:verb>Get</command:verb> <command:noun>TioExportAssetStatus</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Asset Export Requests.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io asset export requests.</maml:para> <maml:para>When no criteria are supplied, status of all recent export requests is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioExportAssetStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by Tag Value UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object Request Details</maml:name> </dev:type> <maml:description> <maml:para>Object containing subset of details about the asset, unless queried by UUID.</maml:para> <maml:para> uuid : 4f375b82-fa19-415d-9dfc-abc9fdadf025 status : FINISHED total_chunks : 1 filters : {"tag.Windows Production Server":"Physical"} finished_chunks : 1 num_assets_per_chunk : 1000 created : 1631847707768</maml:para> <maml:para> uuid : 9a3c2986-1000-485e-8c52-e525797fe4c8 status : FINISHED total_chunks : 1 filters : {"tag.Category 1":"Value 1"} finished_chunks : 1 num_assets_per_chunk : 1000 created : 1631847426722</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Collection of System.Object with all Requests</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Returns the status of an assets export request. Tenable.io processes the chunks in parallel so the chunks may not complete in order, and the chunk IDs may not be arranged sequentially in the completed output.</maml:para> <maml:para>If no UUID is supplied, retrieves a list of asset export jobs. This list includes the 1,000 most recent export jobs regardless of status.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioExportAssetStatus -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all Asset Export Requests</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioExportAssetStatus -ApiKeys $TioApiKeys -Uuid ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get details for Asset Export Request with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Asset Export Status</maml:linkText> <maml:uri>https://developer.tenable.com/reference#exports-assets-export-status</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioFolder</command:name> <command:verb>Get</command:verb> <command:noun>TioFolder</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Folders.</maml:para> <maml:para>When no criteria (Name or Type) are supplied, returns a list of all folders.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioFolder</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Search by Folder Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Optional. Search by Folder Type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Object containing subset of details about the asset, unless queried by UUID.</maml:para> <maml:para> unread_count : 3 custom : 0 default_tag : 1 type : main name : My Scans id : 5</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Tenable.io provides default folders that automatically organize scans. In addition, you can create custom folders to further organize your scans.</maml:para> <maml:para>Use the API to create, list, rename, and delete folders.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioFolder -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all Folders</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioFolder -ApiKeys $TioApiKeys -Name 'My Scans'</dev:code> <dev:remarks> <maml:para>Get all available details for the Folder with name My Scans .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioFolder -ApiKeys $TioApiKeys -Type 'custom'</dev:code> <dev:remarks> <maml:para>List all folders of type custom .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Folders</maml:linkText> <maml:uri>https://developer.tenable.com/reference#folders</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioTagCategory</command:name> <command:verb>Get</command:verb> <command:noun>TioTagCategory</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Tag Categories.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Tag Categories.</maml:para> <maml:para>When no criteria (Uuid, Filter or Name) are supplied, returns all Tag Categories.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioTagCategory</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by Tag Category UUID.</maml:para> <maml:para>Alias: Id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional. Search by Tag Category Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Optional. Search using a filter.</maml:para> <maml:para>A filter condition in the `field:operator:value` format, for example, `f=name:match:location`. Filter conditions can include: name:eq: category_name * name:match: partial_name * description:eq: description * description:match: partial_description * updated_at:date-eq: timestamp_as_int * updated_at:date-gt: timestamp_as_int * updated_at:date-lt: timestamp_as_int * created_at:date-eq: timestamp_as_int * created_at:date-gt: timestamp_as_int * created_at:date-lt: timestamp_as_int * updated_by:eq: user_uuid *</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Object containing subset of details about the asset, unless queried by UUID.</maml:para> <maml:para> uuid : fda11a4e-ffe2-47a2-9492-54575c40e256 created_at : 23/09/2020 06:50:18 created_by : admin@domain.com updated_at : 29/09/2020 04:32:25 updated_by : admin@domain.com name : Linux Production Server description : Linux Production Server reserved : False value_count : 3</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>With tags, you can categorize and create logical groupings of network assets in Tenable.io. Tags are uniquely named and applied across your organization's network. You can provide descriptions of tags and tag categories to better explain their usage.</maml:para> <maml:para>Use the API endpoints to perform standard CRUD operations on tag categories and values, and also assign tags to assets.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagCategory -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all Tag Categories</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagCategory -ApiKeys $TioApiKeys -Uuid ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get details for the Tag Category with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagCategory -ApiKeys $TioApiKeys -Name 'Category 1'</dev:code> <dev:remarks> <maml:para>Get details for the Tag Category with Name Category 1 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioAsset -ApiKeys $TioApiKeys -Filter 'description:match:windows'</dev:code> <dev:remarks> <maml:para>Get a list of Categories where the description contains windows .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Tags</maml:linkText> <maml:uri>https://developer.tenable.com/reference#tags</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TioTagValue</command:name> <command:verb>Get</command:verb> <command:noun>TioTagValue</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Tag Category Values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Tag Category Values.</maml:para> <maml:para>When no criteria (Uuid, Filter, Value or CategoryName) are supplied, returns all Tag Values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioTagValue</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Optional. Defaults to [https://cloud.tenable.com/] , specify to override.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Optional. HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by Tag Value UUID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Optional. Search by Tag Value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CategoryName</maml:name> <maml:description> <maml:para>Optional. Search by CategoryName.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Optional. Search using a filter.</maml:para> <maml:para>A filter condition in the field:operator:value format, for example, f=value:match:rhel. Filters should match field:op:value format. Filter conditions can include: value:eq: tag_value * value:match: value_match * category_name:match: partial_value * category_name:eq: category_name * category_name:match: partial_category_name * description:eq: description * description:match: partial_description * updated_at:date-eq: timestamp_as_int * updated_at:date-gt: timestamp_as_int * updated_at:date-lt: timestamp_as_int * updated_by:eq: user_uuid *</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object Subset of details</maml:name> </dev:type> <maml:description> <maml:para>Object containing subset of details about the asset, unless queried by UUID.</maml:para> <maml:para> uuid : 8f68a869-1cbc-4544-a252-b253cb1f2aaf created_at : 05/10/2020 03:22:50 created_by : admin@domain.com updated_at : 05/10/2020 03:23:43 updated_by : admin@domain.com category_uuid : 6fbd0c51-4eea-4bed-8490-65c590ece437 value : Site A Virtual description : type : static category_name : Linux Production Servers category_description : access_control : @{current_user_permissions=System.Object[]} saved_search : False</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>In Tenable.io, assets are defined as network entities that potentially represent security risks. Assets can include laptops, desktops, servers, routers, mobile phones, virtual machines, software containers, and cloud instances. Tenable.io allows you to track assets that belong to your organization, helping to eliminate potential security risks, identify under-utilized resources, and support compliance efforts.</maml:para> <maml:para>Use the API to list assets, get individual asset information, import assets, and list and check the status of asset import jobs.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagValue -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all Tag Category Values</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagValue -ApiKeys $TioApiKeys -Uuid ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get details for Tag Value with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagValue -ApiKeys $TioApiKeys -Filter 'description:match:sitea'</dev:code> <dev:remarks> <maml:para>Get details for all Tag Values where the description matches sitea .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagValue -ApiKeys $TioApiKeys -Value 'Virtual'</dev:code> <dev:remarks> <maml:para>Get all Tag Values that are equal to Virtual .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Get-TioTagValue -ApiKeys $TioApiKeys -CategoryName 'Windows Production'</dev:code> <dev:remarks> <maml:para>Get all Tag Values for the specified Tag Category.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Assets</maml:linkText> <maml:uri>https://developer.tenable.com/reference#assets</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-TioApiRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>TioApiRequest</command:noun> <maml:description> <maml:para>Make a request to the Tenable.io API</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This is the base function for interacting with the Tenable.io API</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TioApiRequest</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Text string or UriBuilder Object containing the URI to the specific API Endpoint being called, including any URI Parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ApiKeys</maml:name> <maml:description> <maml:para>PSObject containing two PSCredential Objects named AccessKey and SecretKey with the respective Access Key and Secret Key stored in the password property of these.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP Method to use with the API Call. Defaults to GET.</maml:para> <maml:para>Valid values: GET, POST, DELETE, PUT</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>Body to send with the request. Should not be provided with a GET request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Used with recursion, primarily for pagination handling.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is the core API interface function of the module. All other API Call functions call this function to make the actual request to the Tenable API. This allows simplified, direct, calls to be made to the Tenable API where a specific capability is not yet implemented.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = @{} PS > $TioApiKeys.Add('AccessKey',(Get-Credential -UserName 'Access Key')) PS > $TioApiKeys.Add('SecretKey',(Get-Credential -UserName 'Secret Key')) PS > Invoke-TioApiRequest -Uri 'https://cloud.tenable.com/assets' -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List up to 5000 Assets</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference</maml:linkText> <maml:uri>https://developer.tenable.com/reference</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |