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-TioAgent</command:name> <command:verb>Get</command:verb> <command:noun>TioAgent</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Agents.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Agents.</maml:para> <maml:para>When querying a single agent by Agent UUID, returns all properties of the agent. When querying in other ways, a subset of the agent properties may be returned.</maml:para> <maml:para>When no ID/Uuid is supplied, returns all agents using a default page size of 1000.</maml:para> <maml:para>You can retrieve a specific page of assets, with a specified page size.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioAgent</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/](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>Id</maml:name> <maml:description> <maml:para>Optional. Search by asset UUID, returns all details.</maml:para> <maml:para>Alias: 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>Page</maml:name> <maml:description> <maml:para>Optional. Page number of results to retrieve. Page numbers start at 0.</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>Size</maml:name> <maml:description> <maml:para>Optional. Size of Results pages. Defaults to 1000.</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 Agents</maml:name> </dev:type> <maml:description> <maml:para>Optional. Either a bare list of Agent UUIDs, or a list of Agents from a previous call to another function.</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 agent, unless queried by UUID.</maml:para> <maml:para>id : 41474261 uuid : b34ee2ba-4a61-49bc-92c9-26ed23025df7 name : hostname platform : DARWIN distro : macosx ip : 10.1.1.11 last_scanned : 1728950314 plugin_feed_id : 202410141937 core_build : 13 core_version : 10.7.3 linked_on : 1692088612 last_connect : 1728953637 status : on groups : {@{name=MacOS Tenable Agents; id=164396}} supports_remote_logs : True network_uuid : 00000000-0000-0000-0000-000000000000 network_name : Default profile_uuid : 00000000-0000-0000-0000-000000000000 profile_name : Default supports_remote_settings : True asset_uuid : b50c097e-d80c-4fde-bb52-ab4bd9a82e9a health : 20 health_state_name : CRITICAL runtime_scanning_health : -1 nessus_scanning_health : 20</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 : 41474261 uuid : b34ee2ba-4a61-49bc-92c9-26ed23025df7 name : hostname platform : DARWIN distro : macosx ip : 10.1.1.11 last_scanned : 1728950314 plugin_feed_id : 202410141937 core_build : 13 core_version : 10.7.3 linked_on : 1692088612 last_connect : 1728968208 status : on groups : {@{name=MacOS Tenable Agents; id=164396}} supports_remote_logs : True network_uuid : 00000000-0000-0000-0000-000000000000 network_name : Default profile_uuid : 00000000-0000-0000-0000-000000000000 profile_name : Default remote_settings : {@{name=Nessus Agent Log Level; setting=backend_log_level; type=select; description=This controls the Nessus Agent backend logging level. Backend reload required.; backend_reload=True; status=current; value=normal; allowable_values=System.Object[]; default=normal}, @{name=Plugin Compilation Performance; setting=plugin_load_performance_mode; type=select; description=Controls the performance for plugin compilation; lower performance takes longer to compile, but uses fewer system processor resources. Service restart required. Requires 8.1.0+; service_restart=True; status=current; value=high; allowable_values=System.Object[]; default=high}, @{name=Scan Performance; setting=scan_performance_mode; type=select; description=Controls the scan performance; lower performance takes longer to scan, but uses fewer system processor resources. Service restart required. Requires 8.1.0+; service_restart=True; status=current; value=high; allowable_values=System.Object[]; default=high}, @{name=Nessus Agent Update Plan; setting=agent_update_channel; type=select; description=The update plan to which Nessus Agent will track. Requires 7.7.0+; status=current; value=ga; allowable_values=System.Object[]; default=ga}…} supports_remote_settings : True restart_pending : False asset_uuid : b50c097e-d80c-4fde-bb52-ab4bd9a82e9a health : 0 health_state_name : HEALTHY health_events : {@{identifier=100; state=0; state_time=1728954985171; details=The Nessus Agent has enough available disk space to function normally.; muted=False; state_name=HEALTHY; identifier_name=System Disk Usage}, @{identifier=201; state=0; previous_state=20; state_time=1728954734171; previous_state_time=1728953638000; details=Plugin update was successful.; previous_details=The Nessus Agent could not update plugins because the download failed due to an error. Failed plugin updates are retried daily. Status code: 400; muted=False; state_name=HEALTHY; identifier_name=Plugin Updates; previous_state_name=CRITICAL}, @{identifier=202; state=0; state_time=1728954991171; details=Plugin integrity check was successful.; muted=False; state_name=HEALTHY; identifier_name=Plugins Integrity}, @{identifier=203; state=0; state_time=1728954985171; details=Plugin compilation was successful.; muted=False; state_name=HEALTHY; identifier_name=Plugin Compilation}} runtime_scanning_health : -1 nessus_scanning_health : 0</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>In Tenable.io, agents are defined as installations of endpoint software running on assets within the customer's environment for the purpose of collecting vulnerability information related to the host the agent is installed on.</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-TioAgent -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>Get all agents.</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-TioAgent -ApiKeys $TioApiKeys -Id ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get all available details for the agent 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-TioAgent -ApiKeys $TioApiKeys -Page 0</dev:code> <dev:remarks> <maml:para>Get the first page of 1000 agents.</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-TioAgent -ApiKeys $TioApiKeys -Size 20 -Page 5</dev:code> <dev:remarks> <maml:para>Get the sixth page of 20 agents.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-TioExportAsset</command:name> <command:verb>Get</command:verb> <command:noun>TioExportAsset</command:noun> <maml:description> <maml:para>Export Vulnerabilities from Tenable.io.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Initiate a new export request and retrieve results, or get results of a previous Vulnerability 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/](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: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 Vulnerabilities matching search criteria.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Exports all vulnerabilities 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-TioExportVuln -ApiKeys $TioApiKeys -Uuid 'ad082ebc-e375-4250-93b3-ded6dd2757ab'</dev:code> <dev:remarks> <maml:para>Retrieve results of a previous vuln export request with UUID of ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> <maml:para>Use `Get-TioExportVulnStatus -ApiKeys $TioApiKeys` to get a list of available, recent, vuln 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 > $Filter = @{} PS > $Filter.Add('is_licensed',$true) PS > Get-TioExportVuln -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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Export Vulnerabilities Request</maml:linkText> <maml:uri>https://developer.tenable.com/reference/exports-vulns-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 Vuln Export request for the specified Chunk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get results of Vuln 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/](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>Vuln 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 Vulnerabilities matching search criteria.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Downloads exported vulnerabilities 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-TioExportVulnChunk -ApiKeys $TioApiKeys -Uuid 'ad082ebc-e375-4250-93b3-ded6dd2757ab' -Chunk 1</dev:code> <dev:remarks> <maml:para>Retrieve results of the specified vuln export chunk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Download Vulnerabilities Chunk</maml:linkText> <maml:uri>https://developer.tenable.com/reference/exports-vulns-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 Vuln Export Requests.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io vuln export requests.</maml:para> <maml:para>When no criteria are supplied, status of all recent vuln 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/](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 vuln, 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 vuln 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-TioExportVulnStatus -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all Vuln 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-TioExportVulnStatus -ApiKeys $TioApiKeys -Uuid ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get details for Vuln Export Request with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Vuln Export Status</maml:linkText> <maml:uri>https://developer.tenable.com/reference/exports-vulns-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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-TioMsspAccount</command:name> <command:verb>Get</command:verb> <command:noun>TioMsspAccount</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io MSSP Accounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io MSSP Accounts.</maml:para> <maml:para>When no criteria (Uuid, Name or Container) are supplied, returns a list of all MSSP Accounts in the portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioMsspAccount</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/](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>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by Account 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>Name</maml:name> <maml:description> <maml:para>Optional. Search by Custom 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>Container</maml:name> <maml:description> <maml:para>Optional. Search by Container 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>Exact</maml:name> <maml:description> <maml:para>Optional. Switch to make Custom Name exact. Useful if one account name matches a part of another account name.</maml:para> <maml:para>Eg. Customer and Customer - Eval</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 details of the account.</maml:para> <maml:para> uuid : f5e877c6-b078-442e-90ff-b7cd4edff3e9 container_name : domain.com-1111 custom_name : Customer Name 1 sso_username : `contact@customerone.com` region : Asia Pacific (Sydney) site_id : ap-syd-1 licensed_assets : 0 licensed_assets_limit : 100 licensed_apps : {lumin, consec, was, vm…} notes : Account for Customer Name 1</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage and maintain multiple customer instances of Tenable products. Account endpoints in the Tenable.io MSSP Portal API allow you to view and manage your MSSP customer accounts.</maml:para> <maml:para>For background information about the Tenable.io MSSP Portal, see the Tenable.io MSSP Portal User Guide.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspAccount -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all MSSP Accounts</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspAccount -ApiKeys $TioApiKeys -Uuid 'f59e4a2c-183d-43d1-9985-b85abbc0f709'</dev:code> <dev:remarks> <maml:para>Get the available details for an account with UUID f59e4a2c-183d-43d1-9985-b85abbc0f709 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspAccount -ApiKeys $TioApiKeys -Name 'Customer'</dev:code> <dev:remarks> <maml:para>List all Accounts with the text Customer in their name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspAccount -ApiKeys $TioApiKeys -Name 'Customer Name 1' -Exact</dev:code> <dev:remarks> <maml:para>List only the Account with the custom name Customer Name 1 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspAccount -ApiKeys $TioApiKeys -Container 'dommain.com-1112'</dev:code> <dev:remarks> <maml:para>Get the available details for an account with Container Name domain.com-1112 .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : MSSP : Accounts</maml:linkText> <maml:uri>https://developer.tenable.com/reference#io-mssp-accounts</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable.io MSSP Portal User Guide</maml:linkText> <maml:uri>https://docs.tenable.com/tenableio/mssp/Content/Welcome.htm</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-TioMsspLogo</command:name> <command:verb>Get</command:verb> <command:noun>TioMsspLogo</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io MSSP Logos.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io MSSP Logos.</maml:para> <maml:para>When no criteria (Uuid, Name or ContainerId) are supplied, returns a list of all MSSP Logos and their assignments in the portal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioMsspLogo</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/](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>Uuid</maml:name> <maml:description> <maml:para>Optional. Search by Logo 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>Name</maml:name> <maml:description> <maml:para>Optional. Search by Logo 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>ContainerId</maml:name> <maml:description> <maml:para>Optional. Search by Container 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>Exact</maml:name> <maml:description> <maml:para>Optional. Switch to make Logo Name exact. Useful if one account name matches a part of another account name.</maml:para> <maml:para>Eg. Customer and Customer - Eval</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 details of the account.</maml:para> <maml:para>uuid container_uuid name filename</maml:para> <maml:para>---</maml:para> <maml:para>1fa3edcc-8edd-42f7-b6d1-1f5cd1599d4e cc747ae7-9843-4ebb-8793-9424bc9ed000 MSSP Logo 1 logo1.png</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage the logos of their customer's Tenable.io instances. By default, the Tenable.io logo appears in the header of your customer's instances. The logo endpoints allow you to replace the Tenable.io logo with a logo appropriate to a customer's business context. Use these endpoints to add, assign, and delete logos.</maml:para> <maml:para>For background information about logos in the Tenable.io MSSP Portal, see Logos in Tenable.io MSSP Portal User Guide.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>List all MSSP Accounts</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys -Uuid 'f59e4a2c-183d-43d1-9985-b85abbc0f709'</dev:code> <dev:remarks> <maml:para>Get the available details for an logo with UUID f59e4a2c-183d-43d1-9985-b85abbc0f709 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys -Name 'Customer'</dev:code> <dev:remarks> <maml:para>List all logos with the text Customer in their name.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys -Name 'Customer Name 1' -Exact</dev:code> <dev:remarks> <maml:para>List only the logo with the custom name Customer Name 1 .</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys -ContainerId '0f772c9f-acee-4cd0-b476-7bfd17c9a0b9'</dev:code> <dev:remarks> <maml:para>Get the available details for a logo assigned to account with Container Id of 0f772c9f-acee-4cd0-b476-7bfd17c9a0b9 .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : MSSP : Logos</maml:linkText> <maml:uri>https://developer.tenable.com/reference#io-mssp-logos</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable.io MSSP Portal User Guide</maml:linkText> <maml:uri>https://docs.tenable.com/tenableio/mssp/Content/Welcome.htm</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-TioScanner</command:name> <command:verb>Get</command:verb> <command:noun>TioScanner</command:noun> <maml:description> <maml:para>Get details about one or more Tenable.io Scanners.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get details for either a single, or multiple Tenable.io Scanners.</maml:para> <maml:para>When querying a single scanner by scanner UUID, returns all properties of the scanner. When querying in other ways, a subset of the scanner properties may be returned.</maml:para> <maml:para>When no ID/Uuid is supplied, returns all scanners.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioScanner</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/](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>Id</maml:name> <maml:description> <maml:para>Optional. Search by asset UUID, returns all details.</maml:para> <maml:para>Alias: 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>List of Scanners</maml:name> </dev:type> <maml:description> <maml:para>Optional. Either a bare list of Scanner UUIDs, or a list of Scanners from a previous call to another function.</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 scanner, unless queried by UUID.</maml:para> <maml:para>creation_date : 1710838511 group : True id : 201305 key : REDACTED last_connect : last_modification_date : 1710838511 license : @{record_id=0016000001AKju8AAD; customer_id=14217; type=vm; activation_code=REDACTED; agents=-1; ips=200; scanners=-1; users=-1; enterprise_pause=False; expiration_date=1765670399; evaluation=False; apps=; scanners_used=1; agents_used=53} linked : 1 name : UAE Cloud Scanners network_name : Default num_scans : 0 owner : system owner_id : 1 owner_name : system owner_uuid : 01de344d-60e1-4b8d-bd90-13f228892dfc pool : True scan_count : 0 shared : 1 source : service status : on timestamp : 1710838511 type : local user_permissions : 64 uuid : edec1b13-488d-4b5d-affd-a67fe1c71ca2 supports_remote_logs : False supports_webapp : True supports_remote_settings : False</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>In Tenable.io, scanners are used to execute vulnerabilities scans on the customer's environment from either inside the customer's network, or from one of Tenable.io's Cloud Scanners located in multiple regions.</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-TioScanner -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>Get all scanners.</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-TioScanner -ApiKeys $TioApiKeys -Id ad082ebc-e375-4250-93b3-ded6dd2757ab</dev:code> <dev:remarks> <maml:para>Get all available details for the scanner with UUID ad082ebc-e375-4250-93b3-ded6dd2757ab .</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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/](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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-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 Vulnerability Scanning Plugins.</maml:para> <maml:para>When querying a single plugin by Id, returns all properties of the Vulnerability Plugin.</maml:para> <maml:para>When no page number is supplied, all Plugins are returned.</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/](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>Id</maml:name> <maml:description> <maml:para>Optional. Search by Vuln Id, returns all 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>LastUpdated</maml:name> <maml:description> <maml:para>Optional. Search for all Plugins updated since provided date in 'YYYY-MM-DD' format.</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 plugin, unless queried by UUID.</maml:para> <maml:para>id : 10278 name : Sendmail 8.6.9 IDENT Remote Overflow family_name : SMTP problems attributes : {@{attribute_name=fname; attribute_value=sendmail_ident.nasl}, @{attribute_name=plugin_name; attribute_value=Sendmail 8.6.9 IDENT Remote Overflow}, @{attribute_name=script_version; attribute_value=1.18}, @{attribute_name=script_copyright; attribute_value=This script is Copyright (C) 2002-2018 and is owned by Tenable, Inc. or an Affiliate thereof.}…}</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>In Tenable.io, vulnerabilities are detected through the use of plugins. A plugin defines the detection details for a specific vulnerability, and is part of a Plugin Family.</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-TioVulnPlugin -ApiKeys $TioApiKeys</dev:code> <dev:remarks> <maml:para>Get all Vulnerability Scanner plugin details</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-TioVulnPlugin -ApiKeys $TioApiKeys -Id 32</dev:code> <dev:remarks> <maml:para>Get all available details for the plugin with Id 32 .</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-TioVulnPlugin -ApiKeys $TioApiKeys -LastUpdated '2023-12-01'</dev:code> <dev:remarks> <maml:para>Get details of all Vuln Plugins updated since December 1, 2023</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : Assets</maml:linkText> <maml:uri>https://developer.tenable.com/reference/io-plugins-list</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.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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> <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>New-TioCredential</command:name> <command:verb>New</command:verb> <command:noun>TioCredential</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>Build a new PSCustomObject that contains two PSCredential Objects with the Access Key and Secret Key for authentication to the Tenable.IO API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TioCredential</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/](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>AccessKey</maml:name> <maml:description> <maml:para>Optional. A string containing the Access Key.</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>SecretKey</maml:name> <maml:description> <maml:para>Optional. A string containing the Secret Key.</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>API Keys</maml:name> </dev:type> <maml:description> <maml:para>API Key parameters consisting of an Access Key and a Secret Key</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object with PSCredential Objects</maml:name> </dev:type> <maml:description> <maml:para>Object containing a PSCredential Object for each of the Access Key and Secret Key.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>API Keys are used to authenticate with the Tenable.io REST API (version 6.4 or greater) and passed with requests using the "X-ApiKeys" HTTP header. For more details, see the API documentation (https://cloud.tenable.com/api#/authorization.)Note: API Keys are only presented upon initial generation. Please store them in a safe location as they can not be retrieved later and will need to be regenerated if lost. This will invalidate previously issued API Keys for that user.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential</dev:code> <dev:remarks> <maml:para>Create a new Tenable.IO Credential Object for authentication to the API. Access Key and Secret Key will be prompted for.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential -AccessKey 'ACCESS_KEY' -SecretKey 'SECRET_KEY'</dev:code> <dev:remarks> <maml:para>Create a new Tenabe.IO Credential Object for authentication to the API. Access Key and Secret Key supplied as part of the function call.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <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-TioMsspLogo</command:name> <command:verb>Get</command:verb> <command:noun>TioMsspLogo</command:noun> <maml:description> <maml:para>Assign a logo to one or more Tenable.io Accounts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Assign an already defined logo to one or more MSSP Accounts/Containers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TioMsspLogo</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/](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>Uuid</maml:name> <maml:description> <maml:para>Logo UUID to assign to nominated accounts.</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>Accounts</maml:name> <maml:description> <maml:para>List of Account Ids to assign logo to.</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 details of the account.</maml:para> <maml:para>uuid container_uuid name filename</maml:para> <maml:para>---</maml:para> <maml:para>1fa3edcc-8edd-42f7-b6d1-1f5cd1599d4e cc747ae7-9843-4ebb-8793-9424bc9ed000 MSSP Logo 1 logo1.png</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The Tenable.io Managed Security Service Provider (MSSP) Portal API provides a secure and accessible way for MSSP administrators to manage the logos of their customer's Tenable.io instances. By default, the Tenable.io logo appears in the header of your customer's instances. The logo endpoints allow you to replace the Tenable.io logo with a logo appropriate to a customer's business context. Use these endpoints to add, assign, and delete logos.</maml:para> <maml:para>For background information about logos in the Tenable.io MSSP Portal, see Logos in Tenable.io MSSP Portal User Guide.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $TioApiKeys = New-TioCredential PS > Get-TioMsspLogo -ApiKeys $TioApiKeys -Uuid '1fa3edcc-8edd-42f7-b6d1-1f5cd1599d4e' -Accounts 'f59e4a2c-183d-43d1-9985-b85abbc0f709'</dev:code> <dev:remarks> <maml:para>Assign log with ID 1fa3edcc-8edd-42f7-b6d1-1f5cd1599d4e to account with id f59e4a2c-183d-43d1-9985-b85abbc0f709</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Tenable.Tools Project</maml:linkText> <maml:uri>https://github.com/IPSecMSSP/tenable-tools</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable Developer API Reference : MSSP : Logos</maml:linkText> <maml:uri>https://developer.tenable.com/reference#io-mssp-logos</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Tenable.io MSSP Portal User Guide</maml:linkText> <maml:uri>https://docs.tenable.com/tenableio/mssp/Content/Welcome.htm</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |