diff --git a/docs/source/man.j2 b/docs/source/man.j2 index 5b8170ca..6d5041fe 100644 --- a/docs/source/man.j2 +++ b/docs/source/man.j2 @@ -17,7 +17,7 @@ Description The {{ QPC_VAR_PROJECT }} tool, accessed through the ``{{ QPC_VAR_PROGRAM_NAME }}`` command, is an inspection and reporting tool. It is designed to identify environment data, or *facts*, such as the number of physical and virtual systems on a network, their operating systems, and other configuration data. In addition, it is designed to identify and report more detailed facts for some versions of key Red Hat packages and products for the Linux based IT resources in that network. The ability to inspect the software and systems that are running on your network improves your ability to understand and report on your usage. Ultimately, this inspection and reporting process is part of the larger system administration task of managing your inventories. -The {{ QPC_VAR_PROJECT }} tool uses two types of configuration to manage the inspection process. A *credential* contains configuration, such as the username and password or SSH key of the user that runs the inspection process. Certain credential types also support the use of an access token as an alternative authentication method. A *source* defines the entity to be inspected and one or more credentials to use during the inspection process. The entity to be inspected can be a host, subnet, network, or systems management solution such as Openshift, Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. You can save multiple credentials and sources to use with {{ QPC_VAR_PROJECT }} in various combinations as you run inspection processes, or *scans*. When you have completed a scan, you can access the output as a *report* to review the results. +The {{ QPC_VAR_PROJECT }} tool uses two types of configuration to manage the inspection process. A *credential* contains configuration, such as the username and password or SSH key of the user that runs the inspection process. Certain credential types also support the use of an access token as an alternative authentication method. A *source* defines the entity to be inspected and one or more credentials to use during the inspection process. The entity to be inspected can be a host, subnet, network, or systems management solution such as Openshift, Red Hat Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. You can save multiple credentials and sources to use with {{ QPC_VAR_PROJECT }} in various combinations as you run inspection processes, or *scans*. When you have completed a scan, you can access the output as a *report* to review the results. By default, the credentials and sources that are created when using {{ QPC_VAR_PROJECT }} are encrypted in a database. The values are encrypted with AES-256 encryption. They are decrypted when the {{ QPC_VAR_PROJECT }} server runs a scan by using a *vault password* to access the encrypted values that are stored in the database. The {{ QPC_VAR_PROJECT }} tool is an *agentless* inspection tool, so there is no need to install the tool on the sources to be inspected. @@ -134,7 +134,7 @@ Creating and Editing Credentials To create a credential, supply the type of credential and supply SSH credentials as either a username-password pair, a username-key pair, or an access token. The {{ QPC_VAR_PROJECT }} tool stores each set of credentials in a separate credential entry. -**{{ QPC_VAR_PROGRAM_NAME }} cred add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **--username=** *username* **(--password | --sshkeyfile=** *key_file* | --sshkey**)** **[--sshpassphrase]** **--become-method=** *(sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas )* **--become-user=** *user* **[--become-password]** **[--token]** +**{{ QPC_VAR_PROGRAM_NAME }} cred add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **--username=** *username* **(--password | --sshkeyfile=** *key_file* | --sshkey**)** **[--sshpassphrase]** **--become-method=** *(sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas )* **--become-user=** *user* **[--become-password]** **[--token]** ``--name=name`` @@ -142,7 +142,7 @@ To create a credential, supply the type of credential and supply SSH credentials ``--type=type`` - Required. Sets the type of credential. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs`` or ``ansible``. You cannot edit a credential's type after creating it. + Required. Sets the type of credential. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs`` or ``ansible``. You cannot edit a credential's type after creating it. ``--username=username`` @@ -189,11 +189,11 @@ Listing and Showing Credentials The ``{{ QPC_VAR_PROGRAM_NAME }} cred list`` command returns the details for every credential that is configured for {{ QPC_VAR_PROJECT }}. This output includes the name, username, password, SSH keyfile, sudo password, or token (if applicable) for each entry. Passwords and tokens are masked if provided, if not, they will appear as ``null``. -**{{ QPC_VAR_PROGRAM_NAME }} cred list --type=** *(network | vcenter | satellite | openshift | acs | ansible)* +**{{ QPC_VAR_PROGRAM_NAME }} cred list --type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* ``--type=type`` - Optional. Filters the results by credential type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. + Optional. Filters the results by credential type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The ``{{ QPC_VAR_PROGRAM_NAME }} cred show`` command is the same as the ``{{ QPC_VAR_PROGRAM_NAME }} cred list`` command, except that it returns details for a single specified credential. @@ -227,7 +227,7 @@ Sources Use the ``{{ QPC_VAR_PROGRAM_NAME }} source`` command to create and manage sources. -A source contains a single entity or a set of multiple entities that are to be inspected. A source can be one or more physical machines, virtual machines, or containers, or it can be a collection of network information, including IP addresses or host names, or it can be information about a systems management solution such as Openshift, Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. The source also contains information about the SSH ports and SSH credentials that are needed to access the systems to be inspected. The SSH credentials are provided through reference to one or more of the {{ QPC_VAR_PROJECT }} credentials that you configure. +A source contains a single entity or a set of multiple entities that are to be inspected. A source can be one or more physical machines, virtual machines, or containers, or it can be a collection of network information, including IP addresses or host names, or it can be information about a systems management solution such as Openshift, Red Hat Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. The source also contains information about the SSH ports and SSH credentials that are needed to access the systems to be inspected. The SSH credentials are provided through reference to one or more of the {{ QPC_VAR_PROJECT }} credentials that you configure. When you configure a scan, it contains references to one or more sources, including the credentials that are provided in each source. Therefore, you can reference sources in different scan configurations for various purposes, for example, to scan your entire infrastructure or a specific sector of that infrastructure. @@ -236,7 +236,7 @@ Creating and Editing Sources To create a source, supply the type of source with the ``type`` option, one or more host names or IP addresses to connect to with the ``--hosts`` option, and the credentials needed to access those systems with the ``--cred`` option. The ``{{ QPC_VAR_PROGRAM_NAME }} source`` command allows multiple entries for the ``hosts`` and ``cred`` options. Therefore, a single source can access a collection of servers and subnets as needed to create an accurate and complete scan. -**{{ QPC_VAR_PROGRAM_NAME }} source add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **--hosts** *ip_address* **--cred** *credential* **[--exclude-hosts** *ip_address* **]** **[--port=** *port* **]** **[--use-paramiko=** *(True | False)* **]** **[--ssl-cert-verify=** *(True | False)* **]** **[--ssl-protocol=** *protocol* **]** **[--disable-ssl=** *(True | False)* **]** +**{{ QPC_VAR_PROGRAM_NAME }} source add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **--hosts** *ip_address* **--cred** *credential* **[--exclude-hosts** *ip_address* **]** **[--port=** *port* **]** **[--use-paramiko=** *(True | False)* **]** **[--ssl-cert-verify=** *(True | False)* **]** **[--ssl-protocol=** *protocol* **]** **[--disable-ssl=** *(True | False)* **]** ``--name=name`` @@ -244,7 +244,7 @@ To create a source, supply the type of source with the ``type`` option, one or m ``--type=type`` - Required. Sets the type of source. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. The type cannot be edited after a source is created. + Required. Sets the type of source. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The type cannot be edited after a source is created. ``--hosts ip_address`` @@ -282,7 +282,7 @@ To create a source, supply the type of source with the ``type`` option, one or m ``--port=port`` - Optional. Sets a port to be used for the scan. This value supports connection and inspection on a non-standard port. By default, a Network scan uses port 22, vCenter, Ansible, ACS and Satellite scans use port 443, and an Openshift scan uses port 6443. + Optional. Sets a port to be used for the scan. This value supports connection and inspection on a non-standard port. By default, a Network scan uses port 22, vCenter, Ansible, RHACS and Satellite scans use port 443, and an Openshift scan uses port 6443. ``--use-paramiko=(True | False)`` @@ -317,11 +317,11 @@ Listing and Showing Sources The ``{{ QPC_VAR_PROGRAM_NAME }} source list`` command returns the details for all configured sources. The output of this command includes the host names, IP addresses, or IP ranges, the credentials, and the ports that are configured for each source. -**{{ QPC_VAR_PROGRAM_NAME }} source list [--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **]** +**{{ QPC_VAR_PROGRAM_NAME }} source list [--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **]** ``--type=type`` - Optional. Filters the results by source type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. + Optional. Filters the results by source type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The ``{{ QPC_VAR_PROGRAM_NAME }} source show`` command is the same as the ``{{ QPC_VAR_PROGRAM_NAME }} source list`` command, except that it returns details for a single specified source. @@ -354,7 +354,7 @@ Scans Use the ``{{ QPC_VAR_PROGRAM_NAME }} scan`` command to create, run and manage scans. -A scan contains a set of one or more sources of any type, plus additional options that refine how the scan runs, such as the products to omit from the scan, and the maximum number of parallel system scans. Because a scan can combine sources of different types, you can include any combination of Network, OpenShift, Advanced Cluster Security, Ansible Automation Platform, Satellite, and vCenter Server sources in a single scan. When you configure a scan to include multiple sources of different types, for example a Network source and a Satellite source, the same part of your infrastructure might be scanned more than once. The results for this type of scan could show duplicate information in the reported results. However, you have the option to view the unprocessed detailed report that would show these duplicate results for each source type, or a processed deployments report with deduplicated and merged results. +A scan contains a set of one or more sources of any type, plus additional options that refine how the scan runs, such as the products to omit from the scan, and the maximum number of parallel system scans. Because a scan can combine sources of different types, you can include any combination of Network, OpenShift, Red Hat Advanced Cluster Security, Ansible Automation Platform, Satellite, and vCenter Server sources in a single scan. When you configure a scan to include multiple sources of different types, for example a Network source and a Satellite source, the same part of your infrastructure might be scanned more than once. The results for this type of scan could show duplicate information in the reported results. However, you have the option to view the unprocessed detailed report that would show these duplicate results for each source type, or a processed deployments report with deduplicated and merged results. The creation of a scan groups sources, the credentials contained within those sources, and the other options so that the act of running the scan is repeatable. When you run the scan, each instance is saved as a scan job. @@ -510,7 +510,7 @@ Use the ``{{ QPC_VAR_PROGRAM_NAME }} report`` command to retrieve a report from Viewing the Details Report ~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``{{ QPC_VAR_PROGRAM_NAME }} report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Advanced Cluster Security and Ansible scans, as applicable. +The ``{{ QPC_VAR_PROGRAM_NAME }} report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable. **{{ QPC_VAR_PROGRAM_NAME }} report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]** @@ -776,9 +776,9 @@ Examples ``{{ QPC_VAR_PROGRAM_NAME }} cred add --name ansible_cred --type ansible --username ansible_user --password`` -* Creating a new acs type credential +* Creating a new rhacs type credential - ``{{ QPC_VAR_PROGRAM_NAME }} cred add --name acs_cred --type acs --token`` + ``{{ QPC_VAR_PROGRAM_NAME }} cred add --name rhacs_cred --type rhacs --token`` * Listing all credentials @@ -820,9 +820,9 @@ Examples ``{{ QPC_VAR_PROGRAM_NAME }} source add --name ansible_source --type ansible --hosts 10.0.205.205 --ssl-cert-verify false --cred ansible_cred`` -* Creating a new acs source +* Creating a new rhacs source - ``{{ QPC_VAR_PROGRAM_NAME }} source add --name acs_source --type acs --hosts acs-cluster.example.com --cred acs_cred`` + ``{{ QPC_VAR_PROGRAM_NAME }} source add --name rhacs_source --type rhacs --hosts rhacs-cluster.example.com --cred rhacs_cred`` * Editing a source diff --git a/docs/source/man.rst b/docs/source/man.rst index 5e4bf212..5fad3afa 100644 --- a/docs/source/man.rst +++ b/docs/source/man.rst @@ -17,7 +17,7 @@ Description The Quipucords tool, accessed through the ``qpc`` command, is an inspection and reporting tool. It is designed to identify environment data, or *facts*, such as the number of physical and virtual systems on a network, their operating systems, and other configuration data. In addition, it is designed to identify and report more detailed facts for some versions of key Red Hat packages and products for the Linux based IT resources in that network. The ability to inspect the software and systems that are running on your network improves your ability to understand and report on your usage. Ultimately, this inspection and reporting process is part of the larger system administration task of managing your inventories. -The Quipucords tool uses two types of configuration to manage the inspection process. A *credential* contains configuration, such as the username and password or SSH key of the user that runs the inspection process. Certain credential types also support the use of an access token as an alternative authentication method. A *source* defines the entity to be inspected and one or more credentials to use during the inspection process. The entity to be inspected can be a host, subnet, network, or systems management solution such as Openshift, Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. You can save multiple credentials and sources to use with Quipucords in various combinations as you run inspection processes, or *scans*. When you have completed a scan, you can access the output as a *report* to review the results. +The Quipucords tool uses two types of configuration to manage the inspection process. A *credential* contains configuration, such as the username and password or SSH key of the user that runs the inspection process. Certain credential types also support the use of an access token as an alternative authentication method. A *source* defines the entity to be inspected and one or more credentials to use during the inspection process. The entity to be inspected can be a host, subnet, network, or systems management solution such as Openshift, Red Hat Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. You can save multiple credentials and sources to use with Quipucords in various combinations as you run inspection processes, or *scans*. When you have completed a scan, you can access the output as a *report* to review the results. By default, the credentials and sources that are created when using Quipucords are encrypted in a database. The values are encrypted with AES-256 encryption. They are decrypted when the Quipucords server runs a scan by using a *vault password* to access the encrypted values that are stored in the database. The Quipucords tool is an *agentless* inspection tool, so there is no need to install the tool on the sources to be inspected. @@ -134,7 +134,7 @@ Creating and Editing Credentials To create a credential, supply the type of credential and supply SSH credentials as either a username-password pair, a username-key pair, or an access token. The Quipucords tool stores each set of credentials in a separate credential entry. -**qpc cred add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **--username=** *username* **(--password | --sshkeyfile=** *key_file* | --sshkey**)** **[--sshpassphrase]** **--become-method=** *(sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas )* **--become-user=** *user* **[--become-password]** **[--token]** +**qpc cred add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **--username=** *username* **(--password | --sshkeyfile=** *key_file* | --sshkey**)** **[--sshpassphrase]** **--become-method=** *(sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas )* **--become-user=** *user* **[--become-password]** **[--token]** ``--name=name`` @@ -142,7 +142,7 @@ To create a credential, supply the type of credential and supply SSH credentials ``--type=type`` - Required. Sets the type of credential. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs`` or ``ansible``. You cannot edit a credential's type after creating it. + Required. Sets the type of credential. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs`` or ``ansible``. You cannot edit a credential's type after creating it. ``--username=username`` @@ -189,11 +189,11 @@ Listing and Showing Credentials The ``qpc cred list`` command returns the details for every credential that is configured for Quipucords. This output includes the name, username, password, SSH keyfile, sudo password, or token (if applicable) for each entry. Passwords and tokens are masked if provided, if not, they will appear as ``null``. -**qpc cred list --type=** *(network | vcenter | satellite | openshift | acs | ansible)* +**qpc cred list --type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* ``--type=type`` - Optional. Filters the results by credential type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. + Optional. Filters the results by credential type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The ``qpc cred show`` command is the same as the ``qpc cred list`` command, except that it returns details for a single specified credential. @@ -227,7 +227,7 @@ Sources Use the ``qpc source`` command to create and manage sources. -A source contains a single entity or a set of multiple entities that are to be inspected. A source can be one or more physical machines, virtual machines, or containers, or it can be a collection of network information, including IP addresses or host names, or it can be information about a systems management solution such as Openshift, Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. The source also contains information about the SSH ports and SSH credentials that are needed to access the systems to be inspected. The SSH credentials are provided through reference to one or more of the Quipucords credentials that you configure. +A source contains a single entity or a set of multiple entities that are to be inspected. A source can be one or more physical machines, virtual machines, or containers, or it can be a collection of network information, including IP addresses or host names, or it can be information about a systems management solution such as Openshift, Red Hat Advanced Cluster Security, Ansible Automation Platform, vCenter Server, or Satellite. The source also contains information about the SSH ports and SSH credentials that are needed to access the systems to be inspected. The SSH credentials are provided through reference to one or more of the Quipucords credentials that you configure. When you configure a scan, it contains references to one or more sources, including the credentials that are provided in each source. Therefore, you can reference sources in different scan configurations for various purposes, for example, to scan your entire infrastructure or a specific sector of that infrastructure. @@ -236,7 +236,7 @@ Creating and Editing Sources To create a source, supply the type of source with the ``type`` option, one or more host names or IP addresses to connect to with the ``--hosts`` option, and the credentials needed to access those systems with the ``--cred`` option. The ``qpc source`` command allows multiple entries for the ``hosts`` and ``cred`` options. Therefore, a single source can access a collection of servers and subnets as needed to create an accurate and complete scan. -**qpc source add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **--hosts** *ip_address* **--cred** *credential* **[--exclude-hosts** *ip_address* **]** **[--port=** *port* **]** **[--use-paramiko=** *(True | False)* **]** **[--ssl-cert-verify=** *(True | False)* **]** **[--ssl-protocol=** *protocol* **]** **[--disable-ssl=** *(True | False)* **]** +**qpc source add --name=** *name* **--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **--hosts** *ip_address* **--cred** *credential* **[--exclude-hosts** *ip_address* **]** **[--port=** *port* **]** **[--use-paramiko=** *(True | False)* **]** **[--ssl-cert-verify=** *(True | False)* **]** **[--ssl-protocol=** *protocol* **]** **[--disable-ssl=** *(True | False)* **]** ``--name=name`` @@ -244,7 +244,7 @@ To create a source, supply the type of source with the ``type`` option, one or m ``--type=type`` - Required. Sets the type of source. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. The type cannot be edited after a source is created. + Required. Sets the type of source. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The type cannot be edited after a source is created. ``--hosts ip_address`` @@ -282,7 +282,7 @@ To create a source, supply the type of source with the ``type`` option, one or m ``--port=port`` - Optional. Sets a port to be used for the scan. This value supports connection and inspection on a non-standard port. By default, a Network scan uses port 22, vCenter, Ansible, ACS and Satellite scans use port 443, and an Openshift scan uses port 6443. + Optional. Sets a port to be used for the scan. This value supports connection and inspection on a non-standard port. By default, a Network scan uses port 22, vCenter, Ansible, RHACS and Satellite scans use port 443, and an Openshift scan uses port 6443. ``--use-paramiko=(True | False)`` @@ -317,11 +317,11 @@ Listing and Showing Sources The ``qpc source list`` command returns the details for all configured sources. The output of this command includes the host names, IP addresses, or IP ranges, the credentials, and the ports that are configured for each source. -**qpc source list [--type=** *(network | vcenter | satellite | openshift | acs | ansible)* **]** +**qpc source list [--type=** *(network | vcenter | satellite | openshift | rhacs | ansible)* **]** ``--type=type`` - Optional. Filters the results by source type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``acs``, or ``ansible``. + Optional. Filters the results by source type. The value must be ``network``, ``vcenter``, ``satellite``, ``openshift``, ``rhacs``, or ``ansible``. The ``qpc source show`` command is the same as the ``qpc source list`` command, except that it returns details for a single specified source. @@ -354,7 +354,7 @@ Scans Use the ``qpc scan`` command to create, run and manage scans. -A scan contains a set of one or more sources of any type, plus additional options that refine how the scan runs, such as the products to omit from the scan, and the maximum number of parallel system scans. Because a scan can combine sources of different types, you can include any combination of Network, OpenShift, Advanced Cluster Security, Ansible Automation Platform, Satellite, and vCenter Server sources in a single scan. When you configure a scan to include multiple sources of different types, for example a Network source and a Satellite source, the same part of your infrastructure might be scanned more than once. The results for this type of scan could show duplicate information in the reported results. However, you have the option to view the unprocessed detailed report that would show these duplicate results for each source type, or a processed deployments report with deduplicated and merged results. +A scan contains a set of one or more sources of any type, plus additional options that refine how the scan runs, such as the products to omit from the scan, and the maximum number of parallel system scans. Because a scan can combine sources of different types, you can include any combination of Network, OpenShift, Red Hat Advanced Cluster Security, Ansible Automation Platform, Satellite, and vCenter Server sources in a single scan. When you configure a scan to include multiple sources of different types, for example a Network source and a Satellite source, the same part of your infrastructure might be scanned more than once. The results for this type of scan could show duplicate information in the reported results. However, you have the option to view the unprocessed detailed report that would show these duplicate results for each source type, or a processed deployments report with deduplicated and merged results. The creation of a scan groups sources, the credentials contained within those sources, and the other options so that the act of running the scan is repeatable. When you run the scan, each instance is saved as a scan job. @@ -510,7 +510,7 @@ Use the ``qpc report`` command to retrieve a report from a scan. You can retriev Viewing the Details Report ~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``qpc report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Advanced Cluster Security and Ansible scans, as applicable. +The ``qpc report details`` command retrieves a detailed report that contains the unprocessed facts that are gathered during a scan. These facts are the raw output from Network, vCenter, Satellite, Openshift, Red Hat Advanced Cluster Security and Ansible scans, as applicable. **qpc report details (--scan-job** *scan_job_identifier* **|** **--report** *report_identifier* **)** **(--json|--csv)** **--output-file** *path* **[--mask]** @@ -776,9 +776,9 @@ Examples ``qpc cred add --name ansible_cred --type ansible --username ansible_user --password`` -* Creating a new acs type credential +* Creating a new rhacs type credential - ``qpc cred add --name acs_cred --type acs --token`` + ``qpc cred add --name rhacs_cred --type rhacs --token`` * Listing all credentials @@ -820,9 +820,9 @@ Examples ``qpc source add --name ansible_source --type ansible --hosts 10.0.205.205 --ssl-cert-verify false --cred ansible_cred`` -* Creating a new acs source +* Creating a new rhacs source - ``qpc source add --name acs_source --type acs --hosts acs-cluster.example.com --cred acs_cred`` + ``qpc source add --name rhacs_source --type rhacs --hosts rhacs-cluster.example.com --cred rhacs_cred`` * Editing a source diff --git a/qpc/source/__init__.py b/qpc/source/__init__.py index 87b7286d..3371f883 100644 --- a/qpc/source/__init__.py +++ b/qpc/source/__init__.py @@ -12,7 +12,7 @@ OPENSHIFT_SOURCE_TYPE = "openshift" SATELLITE_SOURCE_TYPE = "satellite" VCENTER_SOURCE_TYPE = "vcenter" -ACS_SOURCE_TYPE = "acs" +RHACS_SOURCE_TYPE = "rhacs" SOURCE_URI = "/api/v1/sources/" SOURCE_TYPE_CHOICES = [ @@ -21,7 +21,7 @@ OPENSHIFT_SOURCE_TYPE, SATELLITE_SOURCE_TYPE, VCENTER_SOURCE_TYPE, - ACS_SOURCE_TYPE, + RHACS_SOURCE_TYPE, ] BOOLEAN_CHOICES = ["true", "false"]