Datasets:
mtpti5iD
/
redhat-docs_dataset

Dataset card Data Studio Files Community
1
title
stringlengths
4
168
content
stringlengths
7
1.74M
commands
sequencelengths
1
5.62k
⌀
url
stringlengths
79
342
Chapter 1. The LVM Logical Volume Manager
Chapter 1. The LVM Logical Volume Manager This chapter provides a high-level overview of the components of the Logical Volume Manager (LVM). 1.1. Logical Volumes Volume management creates a layer of abstraction over physical storage, allowing you to create logical storage volumes. This provides much greater flexibility in a number of ways than using physical storage directly. A logical volume provides storage virtualization. With a logical volume, you are not restricted to physical disk sizes. In addition, the hardware storage configuration is hidden from the software so it can be resized and moved without stopping applications or unmounting file systems. This can reduce operational costs. Logical volumes provide the following advantages over using physical storage directly: Flexible capacity When using logical volumes, file systems can extend across multiple disks, since you can aggregate disks and partitions into a single logical volume. Resizeable storage pools You can extend logical volumes or reduce logical volumes in size with simple software commands, without reformatting and repartitioning the underlying disk devices. Online data relocation To deploy newer, faster, or more resilient storage subsystems, you can move data while your system is active. Data can be rearranged on disks while the disks are in use. For example, you can empty a hot-swappable disk before removing it. Convenient device naming Logical storage volumes can be managed in user-defined groups, which you can name according to your convenience. Disk striping You can create a logical volume that stripes data across two or more disks. This can dramatically increase throughput. Mirroring volumes Logical volumes provide a convenient way to configure a mirror for your data. Volume Snapshots Using logical volumes, you can take device snapshots for consistent backups or to test the effect of changes without affecting the real data. The implementation of these features in LVM is described in the remainder of this document.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/cluster_logical_volume_manager/LVM_overview
20.16.9.16. Modifying virtual link state
20.16.9.16. Modifying virtual link state This element provides means of setting state of the virtual network link. Possible values for attribute state are up and down . If down is specified as the value, the interface behaves as if it had the network cable disconnected. Default behavior if this element is unspecified is to have the link state up . To specify the virtual link state configuration settings, use a management tool to make the following changes to the domain XML: ... <devices> <interface type='network'> <source network='default'/> <target dev='vnet0'/> <link state='down'/> </interface> <devices> ... Figure 20.53. Modifying virtual link state
[ "<devices> <interface type='network'> <source network='default'/> <target dev='vnet0'/> <link state='down'/> </interface> <devices>" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/virtualization_administration_guide/sub-sub-section-libvirt-dom-xml-devices-modifying-virtual-link-state
Chapter 1. Prerequisites
Chapter 1. Prerequisites Red Hat Enterprise Linux (RHEL) 9 To obtain the latest version of Red Hat Enterprise Linux (RHEL) 9, see Downlad Red Hat Enterprise Linux . For installation instructions, see the Product Documentation for Red Hat Enterprise Linux 8 . An active subscription to Red Hat Two or more virtual CPUs 4 GB or more of RAM Approximately 30 GB of disk space on your test system, which can be broken down as follows: Approximately 10 GB of disk space for the Red Hat Enterprise Linux (RHEL) operating system. Approximately 10 GB of disk space for Docker storage for running three containers. Approximately 10 GB of disk space for Red Hat Quay local storage. Note CEPH or other local storage might require more memory. More information on sizing can be found at Quay 3.x Sizing Guidlines . 1.1. Installing Podman This document uses Podman for creating and deploying containers. For more information on Podman and related technologies, see Building, running, and managing Linux containers on Red Hat Enterprise Linux 9 . Important If you do not have Podman installed on your system, the use of equivalent Docker commands might be possible, however this is not recommended. Docker has not been tested with Red Hat Quay 3.10, and will be deprecated in a future release. Podman is recommended for highly available, production quality deployments of Red Hat Quay 3.10. Use the following procedure to install Podman. Procedure Enter the following command to install Podman: USD sudo yum install -y podman Alternatively, you can install the container-tools module, which pulls in the full set of container software packages: USD sudo yum module install -y container-tools
[ "sudo yum install -y podman", "sudo yum module install -y container-tools" ]
https://docs.redhat.com/en/documentation/red_hat_quay/3.10/html/proof_of_concept_-_deploying_red_hat_quay/poc-prerequisites
Chapter 4. Image service with multiple stores
Chapter 4. Image service with multiple stores The Red Hat OpenStack Platform (RHOSP) Image service (glance) supports using multiple stores with distributed edge architecture so that you can have an image pool at every edge site. 4.1. Image copies on multiple stores When you use multiple stores with distributed edge architecture, you can have an image pool at every edge site. You can copy images between the central site, which is also known as the hub site, and the edge sites. The image metadata contains the location of each copy. For example, an image present on two edge sites is exposed as a single UUID with three locations: the central site plus the two edge sites. This means you can have copies of image data that share a single UUID on many stores. For more information about locations, see Understanding the location of images . With a RADOS Block Device (RBD) image pool at every edge site, you can boot Virtual Machines (VMs) quickly by using Ceph RBD copy-on-write (COW) and snapshot layering technology. This means that you can boot VMs from volumes and have live migration. For more information about layering with Ceph RBD, see Ceph block device layering in the Block Device Guide . When you launch an instance at an edge site, the required image is copied to the local Image service (glance) store automatically. However, you can copy images in advance from the central Image store to edge sites by using glance multistore to save time during instance launch. 4.2. Requirements of storage edge architecture Refer to the following requirements to use images with edge sites: A copy of each image must exist in the Image service (glance) at the central location. You must copy images from an edge site to the central location before you can copy them to other edge sites. You must use raw images when deploying a Distributed Compute Node (DCN) architecture with Red Hat Ceph Storage. RADOS Block Device (RBD) must be the storage driver for the Image, Compute, and Block Storage services. For each site, you must assign the same value to the NovaComputeAvailabilityZone and CinderStorageAvailabilityZone parameters. 4.3. Import an image to multiple stores Use the interoperable image import workflow to import image data into multiple Ceph Storage clusters. You can import images into the Image service (glance) that are available on the local file system or through a web server. If you import an image from a web server, the image can be imported into multiple stores at once. If the image is not available on a web server, you can import the image from a local file system into the central store and then copy it to additional stores. For more information, see Copy an existing image to multiple stores . Use the Image service command-line client for image management. Important Always store an image copy on the central site, even if there are no instances using the image at the central location. For more information about importing images into the Image service, see the Distributed compute node and storage deployment guide. 4.3.1. Manage image import failures You can manage failures of the image import operation by using the --allow-failure parameter: If the value of the --allow-failure parameter to true , the image status becomes active after the first store successfully imports the data. This is the default setting. You can view a list of stores that failed to import the image data by using the os_glance_failed_import image property. If you set the value of the --allow-failure parameter to false , the image status only becomes active after all specified stores successfully import the data. Failure of any store to import the image data results in an image status of failed . The image is not imported into any of the specified stores. 4.3.2. Importing image data to multiple stores Because the default setting of the --allow-failure parameter is true , you do not need to include the parameter in the command if it is acceptable for some stores to fail to import the image data. Note This procedure does not require all stores to successfully import the image data. Procedure Import image data to multiple, specified stores: Replace IMAGE-NAME with the name of the image you want to import. Replace URI with the URI of the image. Replace STORE1 , STORE2 , and STORE3 with the names of the stores to which you want to import the image data. Alternatively, replace --stores with --all-stores true to upload the image to all the stores. Note The glance image-create-via-import command, which automatically converts the QCOW2 image to RAW format, works only with the web-download method. The glance-direct method is available, but it works only in deployments with a configured shared file system. 4.3.3. Importing image data to multiple stores without failure This procedure requires all stores to successfully import the image data. Procedure Import image data to multiple, specified stores: Replace IMAGE-NAME with the name of the image you want to import. Replace URI with the URI of the image. Replace STORE1 , STORE2 , and STORE3 with the names of stores to which you want to copy the image data. Alternatively, replace --stores with --all-stores true to upload the image to all the stores. Note With the --allow-failure parameter set to false , the Image service does not ignore stores that fail to import the image data. You can view the list of failed stores with the image property os_glance_failed_import . For more information see Checking the progress of the image import operation . Verify that the image data was added to specific stores: Replace IMAGE-ID with the ID of the original existing image. The output displays a comma-delimited list of stores. 4.3.4. Importing image data to a single store You can import image data to a single store. Procedure Import image data to a single store: Replace IMAGE-NAME with the name of the image you want to import. Replace URI with the URI of the image. Replace STORE with the name of the store to which you want to copy the image data. Note If you do not include the options of --stores , --all-stores , or --store in the command, the Image service creates the image in the central store. Verify that the image data was added to specific store: Replace IMAGE-ID with the ID of the original existing image. The output displays a comma-delimited list of stores. 4.3.5. Checking the progress of the image import operation The interoperable image import workflow sequentially imports image data into stores. The size of the image, the number of stores, and the network speed between the central site and the edge sites impact how long it takes for the image import operation to complete. You can follow the progress of the image import by looking at two image properties, which appear in notifications sent during the image import operation: The os_glance_importing_to_stores property lists the stores that have not imported the image data. At the beginning of the import, all requested stores show up in the list. Each time a store successfully imports the image data, the Image service removes the store from the list. The os_glance_failed_import property lists the stores that fail to import the image data. This list is empty at the beginning of the image import operation. Note In the following procedure, the environment has three Ceph Storage clusters: the central store and two stores at the edge, dcn0 and dcn1 . Procedure Verify that the image data was added to specific stores: Replace IMAGE-ID with the ID of the original existing image. The output displays a comma-delimited list of stores similar to the following example snippet: Monitor the status of the image import operation. When you precede a command with watch , the command output refreshes every two seconds. Replace IMAGE-ID with the ID of the original existing image. The status of the operation changes as the image import operation progresses: Output that shows that an image failed to import resembles the following example: After the operation completes, the status changes to active: 4.4. Copy an existing image to multiple stores This feature enables you to copy existing images using Red Hat OpenStack Image service (glance) image data into multiple Ceph Storage stores at the edge by using the interoperable image import workflow. Note The image must be present at the central site before you copy it to any edge sites. Only the image owner or administrator can copy existing images to newly added stores. You can copy existing image data either by setting --all-stores to true or by specifying specific stores to receive the image data. The default setting for the --all-stores option is false . If --all-stores is false , you must specify which stores receive the image data by using --stores STORE1,STORE2 . If the image data is already present in any of the specified stores, the request fails. If you set all-stores to true , and the image data already exists in some of the stores, then those stores are excluded from the list. After you specify which stores receive the image data, the Image service copies data from the central site to a staging area. Then the Image service imports the image data by using the interoperable image import workflow. For more information, see Importing an image to multiple stores . Use the Image service command-line client for image management. Important Red Hat recommends that administrators carefully avoid closely timed image copy requests. Two closely timed copy-image operations for the same image causes race conditions and unexpected results. Existing image data remains as it is, but copying data to new stores fails. 4.4.1. Copying an image to all stores Use the following procedure to copy image data to all available stores. Procedure Copy image data to all available stores: Replace IMAGE-ID with the name of the image you want to copy. Confirm that the image data successfully replicated to all available stores: For information about how to check the status of the image import operation, see Checking the progress of the image import operation . 4.4.2. Copying an image to specific stores Use the following procedure to copy image data to specific stores. Procedure Copy image data to specific stores: Replace IMAGE-ID with the name of the image you want to copy. Replace STORE1 and STORE2 with the names of the stores to which you want to copy the image data. Confirm that the image data successfully replicated to the specified stores: For information about how to check the status of the image import operation, see Checking the progress of the image import operation . 4.5. Deleting an image from a specific store Delete an existing image copy on a specific store by using the Red Hat OpenStack Image service (glance). Use the Image service command-line client for image management. Procedure Delete an image from a specific store: Replace _STORE_ID with the name of the store on which the image copy should be deleted. Replace IMAGE_ID with the ID of the image you want to delete. Warning Using glance image-delete will permanently delete the image across all the sites. All image copies will be deleted, as well as the image instance and metadata. 4.6. Understanding the locations of images Although an image can be present on multiple sites, there is only a single Universal Unique Identifier (UUID) for a given image. The image metadata contains the locations of each copy. For example, an image present on two edge sites is exposed as a single UUID with three locations: the central site and the two edge sites. Note Use the Image service (glance) command-line client instead of the OpenStack command-line client for image management. However, use the openstack image show command to list image location properties. The glance image-show command output does not include locations. Procedure Show the sites on which a copy of the image exists: In the example, the image is present on the central site, the default_backend , and on the two edge sites dcn1 and dcn2 . Alternatively, you can run the glance image-list command with the --include-stores option to see the sites where the images exist: List the image locations properties to show the details of each location: The image properties show the different Ceph RBD URIs for the location of each image. In the example, the central image location URI is: The URI is composed of the following data: 79b70c32-df46-4741-93c0-8118ae2ae284 corresponds to the central Ceph FSID. Each Ceph cluster has a unique FSID. The default value for all sites is images , which corresponds to the Ceph pool on which the images are stored. 2bd882e7-1da0-4078-97fe-f1bb81f61b00 corresponds to the image UUID. The UUID is the same for a given image regardless of its location. The metadata shows the glance store to which this location maps. In this example, it maps to the default_backend , which is the central hub site.
[ "glance image-create-via-import --container-format bare --name IMAGE-NAME --import-method web-download --uri URI --stores STORE1 , STORE2 , STORE3", "glance image-create-via-import --container-format bare --name IMAGE-NAME --import-method web-download --uri URI --stores STORE1 , STORE2", "glance image-show IMAGE-ID | grep stores", "glance image-create-via-import --container-format bare --name IMAGE-NAME --import-method web-download --uri URI --store STORE", "glance image-show IMAGE-ID | grep stores", "glance image-show IMAGE-ID", "| os_glance_failed_import | | os_glance_importing_to_stores | central,dcn0,dcn1 | status | importing", "watch glance image-show IMAGE-ID", "| os_glance_failed_import | | os_glance_importing_to_stores | dcn0,dcn1 | status | importing", "| os_glance_failed_import | dcn0 | os_glance_importing_to_stores | dcn1 | status | importing", "| os_glance_failed_import | dcn0 | os_glance_importing_to_stores | | status | active", "glance image-import IMAGE-ID --all-stores true --import-method copy-image", "glance image-list --include-stores", "glance image-import IMAGE-ID --stores STORE1 , STORE2 --import-method copy-image", "glance image-list --include-stores", "glance stores-delete --store _STORE_ID_ _IMAGE_ID_", "glance image-show ID | grep \"stores\" | stores | default_backend,dcn1,dcn2", "glance image-list --include-stores | ID | Name | Stores | 2bd882e7-1da0-4078-97fe-f1bb81f61b00 | cirros | default_backend,dcn1,dcn2", "openstack image show ID -c properties | properties | (--- cut ---) locations='[{'url': 'rbd://79b70c32-df46-4741-93c0-8118ae2ae284/images/2bd882e7-1da0-4078-97fe-f1bb81f61b00/snap', 'metadata': {'store': 'default_backend'}}, {'url': 'rbd://63df2767-8ddb-4e06-8186-8c155334f487/images/2bd882e7-1da0-4078-97fe-f1bb81f61b00/snap', 'metadata': {'store': 'dcn1'}}, {'url': 'rbd://1b324138-2ef9-4ef9-bd9e-aa7e6d6ead78/images/2bd882e7-1da0-4078-97fe-f1bb81f61b00/snap', 'metadata': {'store': 'dcn2'}}]', (--- cut --)", "rbd://79b70c32-df46-4741-93c0-8118ae2ae284/images/2bd882e7-1da0-4078-97fe-f1bb81f61b00/snap', 'metadata': {'store': 'default_backend'}}" ]
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/creating_and_managing_images/assembly_image-service-with-multiple-stores_osp
Chapter 7. Performing and configuring basic builds
Chapter 7. Performing and configuring basic builds The following sections provide instructions for basic build operations, including starting and canceling builds, editing BuildConfigs , deleting BuildConfigs , viewing build details, and accessing build logs. 7.1. Starting a build You can manually start a new build from an existing build configuration in your current project. Procedure To manually start a build, enter the following command: USD oc start-build <buildconfig_name> 7.1.1. Re-running a build You can manually re-run a build using the --from-build flag. Procedure To manually re-run a build, enter the following command: USD oc start-build --from-build=<build_name> 7.1.2. Streaming build logs You can specify the --follow flag to stream the build's logs in stdout . Procedure To manually stream a build's logs in stdout , enter the following command: USD oc start-build <buildconfig_name> --follow 7.1.3. Setting environment variables when starting a build You can specify the --env flag to set any desired environment variable for the build. Procedure To specify a desired environment variable, enter the following command: USD oc start-build <buildconfig_name> --env=<key>=<value> 7.1.4. Starting a build with source Rather than relying on a Git source pull or a Dockerfile for a build, you can also start a build by directly pushing your source, which could be the contents of a Git or SVN working directory, a set of pre-built binary artifacts you want to deploy, or a single file. This can be done by specifying one of the following options for the start-build command: Option Description --from-dir=<directory> Specifies a directory that will be archived and used as a binary input for the build. --from-file=<file> Specifies a single file that will be the only file in the build source. The file is placed in the root of an empty directory with the same file name as the original file provided. --from-repo=<local_source_repo> Specifies a path to a local repository to use as the binary input for a build. Add the --commit option to control which branch, tag, or commit is used for the build. When passing any of these options directly to the build, the contents are streamed to the build and override the current build source settings. Note Builds triggered from binary input will not preserve the source on the server, so rebuilds triggered by base image changes will use the source specified in the build configuration. Procedure Start a build from a source using the following command to send the contents of a local Git repository as an archive from the tag v2 : USD oc start-build hello-world --from-repo=../hello-world --commit=v2 7.2. Canceling a build You can cancel a build using the web console, or with the following CLI command. Procedure To manually cancel a build, enter the following command: USD oc cancel-build <build_name> 7.2.1. Canceling multiple builds You can cancel multiple builds with the following CLI command. Procedure To manually cancel multiple builds, enter the following command: USD oc cancel-build <build1_name> <build2_name> <build3_name> 7.2.2. Canceling all builds You can cancel all builds from the build configuration with the following CLI command. Procedure To cancel all builds, enter the following command: USD oc cancel-build bc/<buildconfig_name> 7.2.3. Canceling all builds in a given state You can cancel all builds in a given state, such as new or pending , while ignoring the builds in other states. Procedure To cancel all in a given state, enter the following command: USD oc cancel-build bc/<buildconfig_name> 7.3. Editing a BuildConfig To edit your build configurations, you use the Edit BuildConfig option in the Builds view of the Developer perspective. You can use either of the following views to edit a BuildConfig : The Form view enables you to edit your BuildConfig using the standard form fields and checkboxes. The YAML view enables you to edit your BuildConfig with full control over the operations. You can switch between the Form view and YAML view without losing any data. The data in the Form view is transferred to the YAML view and vice versa. Procedure In the Builds view of the Developer perspective, click the menu to see the Edit BuildConfig option. Click Edit BuildConfig to see the Form view option. In the Git section, enter the Git repository URL for the codebase you want to use to create an application. The URL is then validated. Optional: Click Show Advanced Git Options to add details such as: Git Reference to specify a branch, tag, or commit that contains code you want to use to build the application. Context Dir to specify the subdirectory that contains code you want to use to build the application. Source Secret to create a Secret Name with credentials for pulling your source code from a private repository. In the Build from section, select the option that you would like to build from. You can use the following options: Image Stream tag references an image for a given image stream and tag. Enter the project, image stream, and tag of the location you would like to build from and push to. Image Stream image references an image for a given image stream and image name. Enter the image stream image you would like to build from. Also enter the project, image stream, and tag to push to. Docker image : The Docker image is referenced through a Docker image repository. You will also need to enter the project, image stream, and tag to refer to where you would like to push to. Optional: In the Environment Variables section, add the environment variables associated with the project by using the Name and Value fields. To add more environment variables, use Add Value , or Add from ConfigMap and Secret . Optional: To further customize your application, use the following advanced options: Trigger Triggers a new image build when the builder image changes. Add more triggers by clicking Add Trigger and selecting the Type and Secret . Secrets Adds secrets for your application. Add more secrets by clicking Add secret and selecting the Secret and Mount point . Policy Click Run policy to select the build run policy. The selected policy determines the order in which builds created from the build configuration must run. Hooks Select Run build hooks after image is built to run commands at the end of the build and verify the image. Add Hook type , Command , and Arguments to append to the command. Click Save to save the BuildConfig . 7.4. Deleting a BuildConfig You can delete a BuildConfig using the following command. Procedure To delete a BuildConfig , enter the following command: USD oc delete bc <BuildConfigName> This also deletes all builds that were instantiated from this BuildConfig . To delete a BuildConfig and keep the builds instatiated from the BuildConfig , specify the --cascade=false flag when you enter the following command: USD oc delete --cascade=false bc <BuildConfigName> 7.5. Viewing build details You can view build details with the web console or by using the oc describe CLI command. This displays information including: The build source. The build strategy. The output destination. Digest of the image in the destination registry. How the build was created. If the build uses the Docker or Source strategy, the oc describe output also includes information about the source revision used for the build, including the commit ID, author, committer, and message. Procedure To view build details, enter the following command: USD oc describe build <build_name> 7.6. Accessing build logs You can access build logs using the web console or the CLI. Procedure To stream the logs using the build directly, enter the following command: USD oc describe build <build_name> 7.6.1. Accessing BuildConfig logs You can access BuildConfig logs using the web console or the CLI. Procedure To stream the logs of the latest build for a BuildConfig , enter the following command: USD oc logs -f bc/<buildconfig_name> 7.6.2. Accessing BuildConfig logs for a given version build You can access logs for a given version build for a BuildConfig using the web console or the CLI. Procedure To stream the logs for a given version build for a BuildConfig , enter the following command: USD oc logs --version=<number> bc/<buildconfig_name> 7.6.3. Enabling log verbosity You can enable a more verbose output by passing the BUILD_LOGLEVEL environment variable as part of the sourceStrategy or dockerStrategy in a BuildConfig . Note An administrator can set the default build verbosity for the entire OpenShift Container Platform instance by configuring env/BUILD_LOGLEVEL . This default can be overridden by specifying BUILD_LOGLEVEL in a given BuildConfig . You can specify a higher priority override on the command line for non-binary builds by passing --build-loglevel to oc start-build . Available log levels for source builds are as follows: Level 0 Produces output from containers running the assemble script and all encountered errors. This is the default. Level 1 Produces basic information about the executed process. Level 2 Produces very detailed information about the executed process. Level 3 Produces very detailed information about the executed process, and a listing of the archive contents. Level 4 Currently produces the same information as level 3. Level 5 Produces everything mentioned on levels and additionally provides docker push messages. Procedure To enable more verbose output, pass the BUILD_LOGLEVEL environment variable as part of the sourceStrategy or dockerStrategy in a BuildConfig : sourceStrategy: ... env: - name: "BUILD_LOGLEVEL" value: "2" 1 1 Adjust this value to the desired log level.
[ "oc start-build <buildconfig_name>", "oc start-build --from-build=<build_name>", "oc start-build <buildconfig_name> --follow", "oc start-build <buildconfig_name> --env=<key>=<value>", "oc start-build hello-world --from-repo=../hello-world --commit=v2", "oc cancel-build <build_name>", "oc cancel-build <build1_name> <build2_name> <build3_name>", "oc cancel-build bc/<buildconfig_name>", "oc cancel-build bc/<buildconfig_name>", "oc delete bc <BuildConfigName>", "oc delete --cascade=false bc <BuildConfigName>", "oc describe build <build_name>", "oc describe build <build_name>", "oc logs -f bc/<buildconfig_name>", "oc logs --version=<number> bc/<buildconfig_name>", "sourceStrategy: env: - name: \"BUILD_LOGLEVEL\" value: \"2\" 1" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/builds/basic-build-operations
4.3. Basic Virtual Memory Concepts
4.3. Basic Virtual Memory Concepts While the technology behind the construction of the various modern-day storage technologies is truly impressive, the average system administrator does not need to be aware of the details. In fact, there is really only one fact that system administrators should always keep in mind: There is never enough RAM. While this truism might at first seem humorous, many operating system designers have spent a great deal of time trying to reduce the impact of this very real shortage. They have done so by implementing virtual memory -- a way of combining RAM with slower storage to give a system the appearance of having more RAM than is actually installed. 4.3.1. Virtual Memory in Simple Terms Let us start with a hypothetical application. The machine code making up this application is 10000 bytes in size. It also requires another 5000 bytes for data storage and I/O buffers. This means that, to run this application, there must be 15000 bytes of RAM available; even one byte less, and the application would not be able to run. This 15000 byte requirement is known as the application's address space . It is the number of unique addresses needed to hold both the application and its data. In the first computers, the amount of available RAM had to be greater than the address space of the largest application to be run; otherwise, the application would fail with an "out of memory" error. A later approach known as overlaying attempted to alleviate the problem by allowing programmers to dictate which parts of their application needed to be memory-resident at any given time. In this way, code only required once for initialization purposes could be written over (overlayed) with code that would be used later. While overlays did ease memory shortages, it was a very complex and error-prone process. Overlays also failed to address the issue of system-wide memory shortages at runtime. In other words, an overlayed program may require less memory to run than a program that is not overlayed, but if the system still does not have sufficient memory for the overlayed program, the end result is the same -- an out of memory error. With virtual memory, the concept of an application's address space takes on a different meaning. Rather than concentrating on how much memory an application needs to run, a virtual memory operating system continually attempts to find the answer to the question, "how little memory does an application need to run?" While it at first appears that our hypothetical application requires the full 15000 bytes to run, think back to our discussion in Section 4.1, "Storage Access Patterns" -- memory access tends to be sequential and localized. Because of this, the amount of memory required to execute the application at any given time is less than 15000 bytes -- usually a lot less. Consider the types of memory accesses required to execute a single machine instruction: The instruction is read from memory. The data required by the instruction is read from memory. After the instruction completes, the results of the instruction are written back to memory. The actual number of bytes necessary for each memory access varies according to the CPU's architecture, the actual instruction, and the data type. However, even if one instruction required 100 bytes of memory for each type of memory access, the 300 bytes required is still much less than the application's entire 15000-byte address space. If a way could be found to keep track of an application's memory requirements as the application runs, it would be possible to keep the application running while using less memory than its address space would otherwise dictate. But that leaves one question: If only part of the application is in memory at any given time, where is the rest of it?
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/introduction_to_system_administration/s1-memory-concepts
Chapter 1. Upgrade a Red Hat Ceph Storage cluster using cephadm
Chapter 1. Upgrade a Red Hat Ceph Storage cluster using cephadm As a storage administrator, you can use the cephadm Orchestrator to upgrade Red Hat Ceph Storage 5 and later. Note Upgrading directly from Red Hat Ceph Storage 4 to Red Hat Ceph Storage 6 is not supported. The automated upgrade process follows Ceph best practices. For example: The upgrade order starts with Ceph Managers, Ceph Monitors, then other daemons. Each daemon is restarted only after Ceph indicates that the cluster will remain available. The storage cluster health status is likely to switch to HEALTH_WARNING during the upgrade. When the upgrade is complete, the health status should switch back to HEALTH_OK. Warning If you have a Red Hat Ceph Storage 6 cluster with multi-site configured, do not upgrade to the latest version of 6.1.z1 as there are issues with data corruption on encrypted objects when objects replicate to the disaster recovery (DR) site. Note You do not get a message once the upgrade is successful. Run ceph versions and ceph orch ps commands to verify the new image ID and the version of the storage cluster. Warning The Ceph iSCSI gateway is removed from Red Hat Ceph Storage 6. Therefore, you need to manage the iSCSI LUNs before upgrading from Red Hat Ceph Storage 5 to Red Hat Ceph Storage 6. When you upgrade a Red Hat Ceph Storage cluster from RHCS 5 to RHCS 6, RBD images that were exported through iSCSI are preserved, therefore data is not lost. However, because all iSCSI targets disappear with the upgrade, data is temporarily inaccessible. To recover data, you can map such RBD images with rbd device map command or export them to a file with rbd export command. 1.1. Compatibility considerations between RHCS and podman versions podman and Red Hat Ceph Storage have different end-of-life strategies that might make it challenging to find compatible versions. Red Hat recommends to use the podman version shipped with the corresponding Red Hat Enterprise Linux version for Red Hat Ceph Storage. See the Red Hat Ceph Storage: Supported configurations knowledge base article for more details. See the Contacting Red Hat support for service section in the Red Hat Ceph Storage Troubleshooting Guide for additional assistance. The following table shows version compatibility between Red Hat Ceph Storage 6 and versions of podman . Ceph Podman 1.9 2.0 2.1 2.2 3.0 >3.0 Red Hat Ceph Storage 6 false true true false true true Warning To use Podman with Red Hat Ceph Storage 5 and later, you must use a version of Podman that is 2.0.0 or higher. 1.2. Upgrading the Red Hat Ceph Storage cluster You can use ceph orch upgrade command for upgrading a Red Hat Ceph Storage 5.0 cluster. Prerequisites A running Red Hat Ceph Storage cluster 5. Red Hat Enterprise Linux 9.0 or later with ansible-core bundled into AppStream. Root-level access to all the nodes. Ansible user with sudo and passwordless ssh access to all nodes in the storage cluster. At least two Ceph Manager nodes in the storage cluster: one active and one standby. Important Upgrade to the latest version of Red Hat Ceph Storage 5.3.z5 prior to upgrading to the latest version Red Hat Ceph Storage 6.1. Note Red Hat Ceph Storage 5 also includes a health check function that returns a DAEMON_OLD_VERSION warning if it detects that any of the daemons in the storage cluster are running multiple versions of RHCS. The warning is triggered when the daemons continue to run multiple versions of Red Hat Ceph Storage beyond the time value set in the mon_warn_older_version_delay option. By default, the mon_warn_older_version_delay option is set to 1 week. This setting allows most upgrades to proceed without falsely seeing the warning. If the upgrade process is paused for an extended time period, you can mute the health warning: After the upgrade has finished, unmute the health warning: Procedure Enable the Ceph Ansible repositories on the Ansible administration node: Red Hat Enterprise Linux 9 Update the cephadm and cephadm-ansible package: Example Navigate to the /usr/share/cephadm-ansible/ directory: Example Run the preflight playbook with the upgrade_ceph_packages parameter set to true on the bootstrapped host in the storage cluster: Syntax Example This package upgrades cephadm on all the nodes. Log into the cephadm shell: Example Ensure all the hosts are online and that the storage cluster is healthy: Example Set the OSD noout , noscrub , and nodeep-scrub flags to prevent OSDs from getting marked out during upgrade and to avoid unnecessary load on the cluster: Example Check service versions and the available target containers: Syntax Example Note The image name is applicable for both Red Hat Enterprise Linux 8 and Red Hat Enterprise Linux 9. Upgrade the storage cluster: Syntax Example Note To perform a staggered upgrade, see Performing a staggered upgrade . While the upgrade is underway, a progress bar appears in the ceph status output. Example Verify the new IMAGE_ID and VERSION of the Ceph cluster: Example Note If you are not using the cephadm-ansible playbooks, after upgrading your Ceph cluster, you must upgrade the ceph-common package and client libraries on your client nodes. Example Verify you have the latest version: Example When the upgrade is complete, unset the noout , noscrub , and nodeep-scrub flags: Example 1.3. Upgrading the Red Hat Ceph Storage cluster in a disconnected environment You can upgrade the storage cluster in a disconnected environment by using the --image tag. You can use ceph orch upgrade command for upgrading a Red Hat Ceph Storage 5 cluster. Important Red Hat Enterprise Linux 9 and later does not support the cephadm-ansible playbook. Prerequisites A running Red Hat Ceph Storage cluster 5. Red Hat Enterprise Linux 9.0 or later with ansible-core bundled into AppStream. Root-level access to all the nodes. Ansible user with sudo and passwordless ssh access to all nodes in the storage cluster. At least two Ceph Manager nodes in the storage cluster: one active and one standby. Register the nodes to CDN and attach subscriptions. Check for the customer container images in a disconnected environment and change the configuration, if required. See the Changing configurations of custom container images for disconnected installations section in the Red Hat Ceph Storage Installation Guide for more details. By default, the monitoring stack components are deployed based on the primary Ceph image. For disconnected environment of the storage cluster, you have to use the latest available monitoring stack component images. Table 1.1. Custom image details for monitoring stack Monitoring stack component Image details Prometheus registry.redhat.io/openshift4/ose-prometheus:v4.12 Grafana registry.redhat.io/rhceph-6-dashboard-rhel9:latest Node-exporter registry.redhat.io/openshift4/ose-prometheus-node-exporter:v4.12 AlertManager registry.redhat.io/openshift4/ose-prometheus-alertmanager:v4.12 HAProxy registry.redhat.io/rhceph/rhceph-haproxy-rhel9:latest Keepalived registry.redhat.io/rhceph/keepalived-rhel9:latest SNMP Gateway registry.redhat.io/rhceph/snmp-notifier-rhel9:latest Procedure Enable the Ceph Ansible repositories on the Ansible administration node: Red Hat Enterprise Linux 9 Update the cephadm and cephadm-ansible package. Example Run the preflight playbook with the upgrade_ceph_packages parameter set to true and the ceph_origin parameter set to custom on the bootstrapped host in the storage cluster: Syntax Example This package upgrades cephadm on all the nodes. Log into the cephadm shell: Example Ensure all the hosts are online and that the storage cluster is healthy: Example Set the OSD noout , noscrub , and nodeep-scrub flags to prevent OSDs from getting marked out during upgrade and to avoid unnecessary load on the cluster: Example Check service versions and the available target containers: Syntax Example Upgrade the storage cluster: Syntax Example While the upgrade is underway, a progress bar appears in the ceph status output. Example Verify the new IMAGE_ID and VERSION of the Ceph cluster: Example When the upgrade is complete, unset the noout , noscrub , and nodeep-scrub flags: Example Additional Resources See the Registering Red Hat Ceph Storage nodes to the CDN and attaching subscriptions section in the Red Hat Ceph Storage Installation Guide . See the Configuring a private registry for a disconnected installation section in the Red Hat Ceph Storage Installation Guide .
[ "ceph health mute DAEMON_OLD_VERSION --sticky", "ceph health unmute DAEMON_OLD_VERSION", "subscription-manager repos --enable=rhceph-6-tools-for-rhel-9-x86_64-rpms", "dnf update cephadm dnf update cephadm-ansible", "cd /usr/share/cephadm-ansible", "ansible-playbook -i INVENTORY_FILE cephadm-preflight.yml --extra-vars \"ceph_origin=rhcs upgrade_ceph_packages=true\"", "[ceph-admin@admin cephadm-ansible]USD ansible-playbook -i /etc/ansible/hosts cephadm-preflight.yml --extra-vars \"ceph_origin=rhcs upgrade_ceph_packages=true\"", "cephadm shell", "ceph -s", "ceph osd set noout ceph osd set noscrub ceph osd set nodeep-scrub", "ceph orch upgrade check IMAGE_NAME", "ceph orch upgrade check registry.redhat.io/rhceph/rhceph-6-rhel9:latest", "ceph orch upgrade start IMAGE_NAME", "ceph orch upgrade start registry.redhat.io/rhceph/rhceph-6-rhel9:latest", "ceph status [...] progress: Upgrade to 17.2.6-70.el9cp (1s) [............................]", "ceph versions ceph orch ps", "[root@client01 ~] dnf update ceph-common", "[root@client01 ~] ceph --version", "ceph osd unset noout ceph osd unset noscrub ceph osd unset nodeep-scrub", "subscription-manager repos --enable=rhceph-6-tools-for-rhel-9-x86_64-rpms", "dnf update cephadm dnf update cephadm-ansible", "ansible-playbook -i INVENTORY_FILE cephadm-preflight.yml --extra-vars \"ceph_origin=custom upgrade_ceph_packages=true\"", "[ceph-admin@admin ~]USD ansible-playbook -i /etc/ansible/hosts cephadm-preflight.yml --extra-vars \"ceph_origin=custom upgrade_ceph_packages=true\"", "cephadm shell", "ceph -s", "ceph osd set noout ceph osd set noscrub ceph osd set nodeep-scrub", "ceph orch upgrade check IMAGE_NAME", "ceph orch upgrade check LOCAL_NODE_FQDN :5000/rhceph/rhceph-6-rhel9", "ceph orch upgrade start IMAGE_NAME", "ceph orch upgrade start LOCAL_NODE_FQDN :5000/rhceph/rhceph-6-rhel9", "ceph status [...] progress: Upgrade to 17.2.6-70.el9cp (1s) [............................]", "ceph version ceph versions ceph orch ps", "ceph osd unset noout ceph osd unset noscrub ceph osd unset nodeep-scrub" ]
https://docs.redhat.com/en/documentation/red_hat_ceph_storage/6/html/upgrade_guide/upgrade-a-red-hat-ceph-storage-cluster-using-cephadm
Chapter 1. Prerequisites
Chapter 1. Prerequisites You can use installer-provisioned installation to install OpenShift Container Platform on IBM Cloud(R) Bare Metal (Classic) nodes. This document describes the prerequisites and procedures when installing OpenShift Container Platform on IBM Cloud(R) nodes. Important Red Hat supports IPMI and PXE on the provisioning network only. Red Hat has not tested Red Fish, virtual media, or other complementary technologies such as Secure Boot on IBM Cloud(R) deployments. A provisioning network is required. Installer-provisioned installation of OpenShift Container Platform requires: One node with Red Hat Enterprise Linux CoreOS (RHCOS) 8.x installed, for running the provisioner Three control plane nodes One routable network One provisioning network Before starting an installer-provisioned installation of OpenShift Container Platform on IBM Cloud(R) Bare Metal (Classic), address the following prerequisites and requirements. 1.1. Setting up IBM Cloud Bare Metal (Classic) infrastructure To deploy an OpenShift Container Platform cluster on IBM Cloud(R) Bare Metal (Classic) infrastructure, you must first provision the IBM Cloud(R) nodes. Important Red Hat supports IPMI and PXE on the provisioning network only. Red Hat has not tested Red Fish, virtual media, or other complementary technologies such as Secure Boot on IBM Cloud(R) deployments. The provisioning network is required. You can customize IBM Cloud(R) nodes using the IBM Cloud(R) API. When creating IBM Cloud(R) nodes, you must consider the following requirements. Use one data center per cluster All nodes in the OpenShift Container Platform cluster must run in the same IBM Cloud(R) data center. Create public and private VLANs Create all nodes with a single public VLAN and a single private VLAN. Ensure subnets have sufficient IP addresses IBM Cloud(R) public VLAN subnets use a /28 prefix by default, which provides 16 IP addresses. That is sufficient for a cluster consisting of three control plane nodes, four worker nodes, and two IP addresses for the API VIP and Ingress VIP on the baremetal network. For larger clusters, you might need a smaller prefix. IBM Cloud(R) private VLAN subnets use a /26 prefix by default, which provides 64 IP addresses. IBM Cloud(R) Bare Metal (Classic) uses private network IP addresses to access the Baseboard Management Controller (BMC) of each node. OpenShift Container Platform creates an additional subnet for the provisioning network. Network traffic for the provisioning network subnet routes through the private VLAN. For larger clusters, you might need a smaller prefix. Table 1.1. IP addresses per prefix IP addresses Prefix 32 /27 64 /26 128 /25 256 /24 Configuring NICs OpenShift Container Platform deploys with two networks: provisioning : The provisioning network is a non-routable network used for provisioning the underlying operating system on each node that is a part of the OpenShift Container Platform cluster. baremetal : The baremetal network is a routable network. You can use any NIC order to interface with the baremetal network, provided it is not the NIC specified in the provisioningNetworkInterface configuration setting or the NIC associated to a node's bootMACAddress configuration setting for the provisioning network. While the cluster nodes can contain more than two NICs, the installation process only focuses on the first two NICs. For example: NIC Network VLAN NIC1 provisioning <provisioning_vlan> NIC2 baremetal <baremetal_vlan> In the example, NIC1 on all control plane and worker nodes connects to the non-routable network ( provisioning ) that is only used for the installation of the OpenShift Container Platform cluster. NIC2 on all control plane and worker nodes connects to the routable baremetal network. PXE Boot order NIC1 PXE-enabled provisioning network 1 NIC2 baremetal network. 2 Note Ensure PXE is enabled on the NIC used for the provisioning network and is disabled on all other NICs. Configuring canonical names Clients access the OpenShift Container Platform cluster nodes over the baremetal network. Configure IBM Cloud(R) subdomains or subzones where the canonical name extension is the cluster name. For example: Creating DNS entries You must create DNS A record entries resolving to unused IP addresses on the public subnet for the following: Usage Host Name IP API api.<cluster_name>.<domain> <ip> Ingress LB (apps) *.apps.<cluster_name>.<domain> <ip> Control plane and worker nodes already have DNS entries after provisioning. The following table provides an example of fully qualified domain names. The API and Nameserver addresses begin with canonical name extensions. The host names of the control plane and worker nodes are examples, so you can use any host naming convention you prefer. Usage Host Name IP API api.<cluster_name>.<domain> <ip> Ingress LB (apps) *.apps.<cluster_name>.<domain> <ip> Provisioner node provisioner.<cluster_name>.<domain> <ip> Master-0 openshift-master-0.<cluster_name>.<domain> <ip> Master-1 openshift-master-1.<cluster_name>.<domain> <ip> Master-2 openshift-master-2.<cluster_name>.<domain> <ip> Worker-0 openshift-worker-0.<cluster_name>.<domain> <ip> Worker-1 openshift-worker-1.<cluster_name>.<domain> <ip> Worker-n openshift-worker-n.<cluster_name>.<domain> <ip> OpenShift Container Platform includes functionality that uses cluster membership information to generate A records. This resolves the node names to their IP addresses. After the nodes are registered with the API, the cluster can disperse node information without using CoreDNS-mDNS. This eliminates the network traffic associated with multicast DNS. Important After provisioning the IBM Cloud(R) nodes, you must create a DNS entry for the api.<cluster_name>.<domain> domain name on the external DNS because removing CoreDNS causes the local entry to disappear. Failure to create a DNS record for the api.<cluster_name>.<domain> domain name in the external DNS server prevents worker nodes from joining the cluster. Network Time Protocol (NTP) Each OpenShift Container Platform node in the cluster must have access to an NTP server. OpenShift Container Platform nodes use NTP to synchronize their clocks. For example, cluster nodes use SSL certificates that require validation, which might fail if the date and time between the nodes are not in sync. Important Define a consistent clock date and time format in each cluster node's BIOS settings, or installation might fail. Configure a DHCP server IBM Cloud(R) Bare Metal (Classic) does not run DHCP on the public or private VLANs. After provisioning IBM Cloud(R) nodes, you must set up a DHCP server for the public VLAN, which corresponds to OpenShift Container Platform's baremetal network. Note The IP addresses allocated to each node do not need to match the IP addresses allocated by the IBM Cloud(R) Bare Metal (Classic) provisioning system. See the "Configuring the public subnet" section for details. Ensure BMC access privileges The "Remote management" page for each node on the dashboard contains the node's intelligent platform management interface (IPMI) credentials. The default IPMI privileges prevent the user from making certain boot target changes. You must change the privilege level to OPERATOR so that Ironic can make those changes. In the install-config.yaml file, add the privilegelevel parameter to the URLs used to configure each BMC. See the "Configuring the install-config.yaml file" section for additional details. For example: ipmi://<IP>:<port>?privilegelevel=OPERATOR Alternatively, contact IBM Cloud(R) support and request that they increase the IPMI privileges to ADMINISTRATOR for each node. Create bare metal servers Create bare metal servers in the IBM Cloud(R) dashboard by navigating to Create resource Bare Metal Servers for Classic . Alternatively, you can create bare metal servers with the ibmcloud CLI utility. For example: USD ibmcloud sl hardware create --hostname <SERVERNAME> \ --domain <DOMAIN> \ --size <SIZE> \ --os <OS-TYPE> \ --datacenter <DC-NAME> \ --port-speed <SPEED> \ --billing <BILLING> See Installing the stand-alone IBM Cloud(R) CLI for details on installing the IBM Cloud(R) CLI. Note IBM Cloud(R) servers might take 3-5 hours to become available.
[ "<cluster_name>.<domain>", "test-cluster.example.com", "ipmi://<IP>:<port>?privilegelevel=OPERATOR", "ibmcloud sl hardware create --hostname <SERVERNAME> --domain <DOMAIN> --size <SIZE> --os <OS-TYPE> --datacenter <DC-NAME> --port-speed <SPEED> --billing <BILLING>" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.17/html/installing_on_ibm_cloud_classic/install-ibm-cloud-prerequisites
Chapter 2. Protecting SAP HANA installation by using fapolicyd
Chapter 2. Protecting SAP HANA installation by using fapolicyd You can perform the following steps to protect a SAP HANA installation: Installing the fapolicyd package. Setting the integrity checking to SHA-256 hashes. Adding custom fapolicyd rules to protect shell scripts. Marking the SAP HANA files as trusted. Enabling the fapolicyd service. 2.1. Installing the fapolicyd package Procedure Install the fapolicyd package: Verification Use the following command to verify that the fapolicyd service is installed but not currently running: 2.2. Setting the integrity checking to SHA-256 hashes By default, fapolicyd verifies the file names while deciding if an application has to be blocked from execution. You can modify this setting to SHA-256 for a higher level of protection. Prerequisites The fapolicyd package is installed on your system. Procedure Open the /etc/fapolicyd/fapolicyd.conf file in a text editor of your choice, for example: Configure the integrity option and change the default value of none to sha-256 : For the change to become effective, you need to restart the fapolicyd service. But you must not restart the fapolicyd now, as you have to make more changes to the fapolicyd configuration. Verification Verify the correct entry: The SAP HANA benchmark was tested on RHEL 9.2. While doing so, initially fapolicyd was disabled and then enabled to evaluate the performance implications of fapolicyd . To allow the tests to run, a total of 19,184 entries were added to the fapolicyd trust files. In 99% of the tests, the performance impact was 5% or less, with the vast majority of the tests experiencing a slowdown of 1-3%. Please note that certain workloads may experience a higher performance penalty. Therefore, you must thoroughly evaluate performance within your specific environment to observe potential impacts accurately. 2.3. Adding custom fapolicyd rules to protect shell scripts By default, fapolicyd blocks binary executable files and certain programs (e.g., Python) from being executed. To also protect shell scripts in the SAP HANA installation directories, you have to add new custom rules. Prerequisites The fapolicyd package is installed on your system. Procedure Open the directory /etc/fapolicyd/rules.d . Add a new file with a file name starting with 71 (proposed file name: 71-sap-shellscript.rules ) so the rule is placed between the rules of the files 70-trusted-lang.rules and 72-shell.rules , with the following content: Set the ownership of the file to those of the other files in /etc/fapolicyd/rules.d : Use the following commands to confirm that new rules have been defined, and then load the new rules: Verification Verify that the rules are updated: 2.4. Marking the SAP HANA files as trusted Prerequisite The fapolicyd package is installed on your system. Procedure Install the SAP HANA software if not already done. Use the following commands to add all the SAP HANA files to the fapolicyd trust database. We recommend using a separate trust file for each directory tree, for example, hana and usr_sap : This creates two files, named hana and usr_sap , in the directory /etc/fapolicyd/trust.d , which contains entries for all files under /hana and /usr/sap . For an SAP HANA installation on a freshly installed RHEL system, the SAP HANA installer creates the directories /hana and /usr/sap , so we can trust that all the files in these directories are valid SAP files. In any other case, there might be files in those directories that the SAP HANA installer has not created. Therefore, you should carefully verify that all the files in the trust files /etc/fapolicyd/trust.d/hana and /etc/fapolicyd/trust.d/usr_sap are valid SAP files. One of the possible ways is explained below: Perform a fresh SAP HANA installation on another freshly installed RHEL system. Repeat step 2 on that system. Compare the resulting trust files of both systems. 2.5. Enabling the fapolicyd service Prerequisites The fapolicyd package is installed and not currently running on your system. You have completed all the steps. Procedure Enable and start the fapolicyd service: The fapolicyd service now protects the SAP HANA system. Scripts and binaries in /hana or /usr/sap that are not in the fapolicyd trust files are blocked, and non-root users cannot execute these files. Verification Verify that the fapolicyd service is up and running: Verify that the non-root users, including the SAP HANA administrator user (example: h70adm ), cannot execute any new scripts and binary programs in /hana and /usr/sap :
[ "dnf install fapolicyd", "systemctl status fapolicyd ● fapolicyd.service - File Access Policy Daemon Loaded: loaded (/usr/lib/systemd/system/fapolicyd.service; enabled; vendor preset: disabled) Active: inactive (dead) since Fri 2024-04-19 14:59:52 CEST; 1s ago Apr 19 14:59:51 host01 fapolicyd[337927]: shutting down Apr 19 14:59:51 host01 systemd[1]: Stopping File Access Policy Daemon Apr 19 14:59:52 host01 systemd[1]: fapolicyd.service: Succeeded. Apr 19 14:59:52 host01 systemd[1]: Stopped File Access Policy Daemon.", "vi /etc/fapolicyd/fapolicyd.conf", "integrity = sha-256", "fapolicyd-cli --check-config Daemon config is OK", "Deny shell script execution and sourcing under SAP HANA directories deny_audit perm=any all : ftype=text/x-shellscript dir=/hana/,/usr/sap/ trust=0", "chown root:fapolicyd 71-sap-shellscript.rules", "fagenrules --check /usr/sbin/fagenrules: Rules have changed and should be updated fagenrules --load", "fagenrules --check /usr/sbin/fagenrules: No change", "fapolicyd-cli --file add /hana --trust-file hana fapolicyd-cli --file add /usr/sap --trust-file usr_sap", "systemctl enable --now fapolicyd", "systemctl status fapolicyd ● fapolicyd.service - File Access Policy Daemon Loaded: loaded (/usr/lib/systemd/system/fapolicyd.service; enabled; preset: disabled) Active: active (running) since Thu 2024-03-14 16:38:32 IST; 18h ago Mar 14 16:38:33 host01 fapolicyd[579216]: Trust database checks OK Mar 14 16:38:33 host01 fapolicyd[579216]: Starting to listen for events", "cp -pi /usr/bin/date /hana/ su - h70adm h70adm@host01:/usr/sap/H70/HDB35> /hana/date -sh: /hana/date: Operation not permitted h70adm@host01:/usr/sap/H70/HDB35> cat > try-to-start-me.sh #!/bin/bash echo \"I will not execute.\" <ctrl>d h70adm@host01:/usr/sap/H70/HDB35> chmod u+x try-to-start-me.sh h70adm@host01:/usr/sap/H70/HDB35> ./try-to-start-me.sh -sh: ./try-to-start-me.sh: Operation not permitted h70adm@host01:/usr/sap/H70/HDB35> rm try-to-start-me.sh h70adm@host01:/usr/sap/H70/HDB35> exit rm /hana/date rm: remove regular file '/hana/date'? y" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux_for_sap_solutions/9/html/configuring_fapolicyd_to_allow_only_sap_hana_executables/con_using_configuring-fapolicyd
Chapter 2. An overview of OpenShift Data Foundation architecture
Chapter 2. An overview of OpenShift Data Foundation architecture Red Hat OpenShift Data Foundation provides services for, and can run internally from Red Hat OpenShift Container Platform. Figure 2.1. Red Hat OpenShift Data Foundation architecture Red Hat OpenShift Data Foundation supports deployment into Red Hat OpenShift Container Platform clusters deployed on Installer Provisioned Infrastructure or User Provisioned Infrastructure. For details about these two approaches, see OpenShift Container Platform - Installation process . To know more about interoperability of components for the Red Hat OpenShift Data Foundation and Red Hat OpenShift Container Platform, see the interoperability matrix . For information about the architecture and lifecycle of OpenShift Container Platform, see OpenShift Container Platform architecture .
null
https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.13/html/red_hat_openshift_data_foundation_architecture/an-overview-of-openshift-data-foundation-architecture_rhodf
Appendix C. Boot options reference
Appendix C. Boot options reference You can use the boot options to modify the default behavior of the installation program. C.1. Installation source boot options This section describes various installation source boot options. inst.repo= The inst.repo= boot option specifies the installation source, that is, the location providing the package repositories and a valid .treeinfo file that describes them. For example: inst.repo=cdrom . The target of the inst.repo= option must be one of the following installation media: an installable tree, which is a directory structure containing the installation program images, packages, and repository data as well as a valid .treeinfo file a DVD (a physical disk present in the system DVD drive) an ISO image of the full Red Hat Enterprise Linux installation DVD, placed on a disk or a network location accessible to the system. Use the inst.repo= boot option to configure different installation methods using different formats. The following table contains details of the inst.repo= boot option syntax: Table C.1. Types and format for the inst.repo= boot option and installation source Source type Boot option format Source format CD/DVD drive inst.repo=cdrom: <device> Installation DVD as a physical disk. [a] Mountable device (HDD and USB stick) inst.repo=hd: <device> :/ <path> Image file of the installation DVD. NFS Server inst.repo=nfs:[ options :] <server> :/ <path> Image file of the installation DVD, or an installation tree, which is a complete copy of the directories and files on the installation DVD. [b] HTTP Server inst.repo=http:// <host> / <path> Installation tree that is a complete copy of the directories and files on the installation DVD. HTTPS Server inst.repo=https:// <host> / <path> FTP Server inst.repo=ftp:// <username> : <password> @ <host> / <path> HMC inst.repo=hmc [a] If device is left out, installation program automatically searches for a drive containing the installation DVD. [b] The NFS Server option uses NFS protocol version 3 by default. To use a different version, add nfsvers= X to options , replacing X with the version number that you want to use. Set disk device names with the following formats: Kernel device name, for example /dev/sda1 or sdb2 File system label, for example LABEL=Flash or LABEL=RHEL8 File system UUID, for example UUID=8176c7bf-04ff-403a-a832-9557f94e61db Non-alphanumeric characters must be represented as \xNN , where NN is the hexadecimal representation of the character. For example, \x20 is a white space (" ") . inst.addrepo= Use the inst.addrepo= boot option to add an additional repository that you can use as another installation source along with the main repository ( inst.repo= ). You can use the inst.addrepo= boot option multiple times during one boot. The following table contains details of the inst.addrepo= boot option syntax. Note The REPO_NAME is the name of the repository and is required in the installation process. These repositories are only used during the installation process; they are not installed on the installed system. For more information about unified ISO, see Unified ISO. Table C.2. Installation sources and boot option format Installation source Boot option format Additional information Installable tree at a URL inst.addrepo=REPO_NAME,[http,https,ftp]:// <host> / <path> Looks for the installable tree at a given URL. Installable tree at an NFS path inst.addrepo=REPO_NAME,nfs:// <server> :/ <path> Looks for the installable tree at a given NFS path. A colon is required after the host. The installation program passes everything after nfs:// directly to the mount command instead of parsing URLs according to RFC 2224. Installable tree in the installation environment inst.addrepo=REPO_NAME,file:// <path> Looks for the installable tree at the given location in the installation environment. To use this option, the repository must be mounted before the installation program attempts to load the available software groups. The benefit of this option is that you can have multiple repositories on one bootable ISO, and you can install both the main repository and additional repositories from the ISO. The path to the additional repositories is /run/install/source/REPO_ISO_PATH . Additionally, you can mount the repository directory in the %pre section in the Kickstart file. The path must be absolute and start with / , for example inst.addrepo=REPO_NAME,file:/// <path> Disk inst.addrepo=REPO_NAME,hd: <device> : <path> Mounts the given <device> partition and installs from the ISO that is specified by the <path> . If the <path> is not specified, the installation program looks for a valid installation ISO on the <device> . This installation method requires an ISO with a valid installable tree. inst.stage2= The inst.stage2= boot option specifies the location of the installation program's runtime image. This option expects the path to a directory that contains a valid .treeinfo file and reads the runtime image location from the .treeinfo file. If the .treeinfo file is not available, the installation program attempts to load the image from images/install.img . When you do not specify the inst.stage2 option, the installation program attempts to use the location specified with the inst.repo option. Use this option when you want to manually specify the installation source in the installation program at a later time. For example, when you want to select the Content Delivery Network (CDN) as an installation source. The installation DVD and Boot ISO already contain a suitable inst.stage2 option to boot the installation program from the respective ISO. If you want to specify an installation source, use the inst.repo= option instead. Note By default, the inst.stage2= boot option is used on the installation media and is set to a specific label; for example, inst.stage2=hd:LABEL=RHEL-x-0-0-BaseOS-x86_64 . If you modify the default label of the file system that contains the runtime image, or if you use a customized procedure to boot the installation system, verify that the inst.stage2= boot option is set to the correct value. inst.noverifyssl Use the inst.noverifyssl boot option to prevent the installer from verifying SSL certificates for all HTTPS connections with the exception of additional Kickstart repositories, where --noverifyssl can be set per repository. For example, if your remote installation source is using self-signed SSL certificates, the inst.noverifyssl boot option enables the installer to complete the installation without verifying the SSL certificates. Example when specifying the source using inst.stage2= Example when specifying the source using inst.repo= inst.stage2.all Use the inst.stage2.all boot option to specify several HTTP, HTTPS, or FTP sources. You can use the inst.stage2= boot option multiple times with the inst.stage2.all option to fetch the image from the sources sequentially until one succeeds. For example: inst.dd= The inst.dd= boot option is used to perform a driver update during the installation. For more information about how to update drivers during installation, see the Updating drivers during installation . inst.repo=hmc This option eliminates the requirement of an external network setup and expands the installation options. When booting from a Binary DVD, the installation program prompts you to enter additional kernel parameters. To set the DVD as an installation source, append the inst.repo=hmc option to the kernel parameters. The installation program then enables support element (SE) and hardware management console (HMC) file access, fetches the images for stage2 from the DVD, and provides access to the packages on the DVD for software selection. Important To use the inst.repo boot option, ensure the user is configured with a minimum of Privilege Class B . For more information about the user configuration, see IBM documentation . inst.proxy= This boot option is used when performing an installation from a HTTP, HTTPS, and FTP protocol. For example: inst.nosave= Use the inst.nosave= boot option to control the installation logs and related files that are not saved to the installed system, for example input_ks , output_ks , all_ks , logs and all . You can combine multiple values separated by a comma. For example, Note The inst.nosave boot option is used for excluding files from the installed system that cannot be removed by a Kickstart %post script, such as logs and input/output Kickstart results. input_ks Disables the ability to save the input Kickstart results. output_ks Disables the ability to save the output Kickstart results generated by the installation program. all_ks Disables the ability to save the input and output Kickstart results. logs Disables the ability to save all installation logs. all Disables the ability to save all Kickstart results, and all logs. inst.multilib Use the inst.multilib boot option to set DNF's multilib_policy to all , instead of best . inst.memcheck The inst.memcheck boot option performs a check to verify that the system has enough RAM to complete the installation. If there is not enough RAM, the installation process is stopped. The system check is approximate and memory usage during installation depends on the package selection, user interface, for example graphical or text, and other parameters. inst.nomemcheck The inst.nomemcheck boot option does not perform a check to verify if the system has enough RAM to complete the installation. Any attempt to perform the installation with less than the minimum amount of memory is unsupported, and might result in the installation process failing. C.2. Network boot options If your scenario requires booting from an image over the network instead of booting from a local image, you can use the following options to customize network booting. Note Initialize the network with the dracut tool. For complete list of dracut options, see the dracut.cmdline(7) man page on your system. ip= Use the ip= boot option to configure one or more network interfaces. To configure multiple interfaces, use one of the following methods; use the ip option multiple times, once for each interface; to do so, use the rd.neednet=1 option, and specify a primary boot interface using the bootdev option. use the ip option once, and then use Kickstart to set up further interfaces. This option accepts several different formats. The following tables contain information about the most common options. In the following tables: The ip parameter specifies the client IP address and IPv6 requires square brackets, for example 192.0.2.1 or [2001:db8::99]. The gateway parameter is the default gateway. IPv6 requires square brackets. The netmask parameter is the netmask to be used. This can be either a full netmask (for example, 255.255.255.0) or a prefix (for example, 64). The hostname parameter is the host name of the client system. This parameter is optional. Table C.3. Boot option formats to configure the network interface Boot option format Configuration method ip= method Automatic configuration of any interface ip= interface:method Automatic configuration of a specific interface ip= ip::gateway:netmask:hostname:interface :none Static configuration, for example, IPv4: ip=192.0.2.1::192.0.2.254:255.255.255.0:server.example.com:enp1s0:none IPv6: ip=[2001:db8::1]::[2001:db8::fffe]:64:server.example.com:enp1s0:none ip= ip::gateway:netmask:hostname:interface:method:mtu Automatic configuration of a specific interface with an override Configuration methods for the automatic interface The method automatic configuration of a specific interface with an override opens the interface using the specified method of automatic configuration, such as dhcp , but overrides the automatically obtained IP address, gateway, netmask, host name or other specified parameters. All parameters are optional, so specify only the parameters that you want to override. The method parameter can be any of the following: DHCP dhcp IPv6 DHCP dhcp6 IPv6 automatic configuration auto6 iSCSI Boot Firmware Table (iBFT) ibft Note If you use a boot option that requires network access, such as inst.ks=http://host/path , without specifying the ip option, the default value of the ip option is ip=dhcp .. To connect to an iSCSI target automatically, activate a network device for accessing the target by using the ip=ibft boot option. nameserver= The nameserver= option specifies the address of the name server. You can use this option multiple times. Note The ip= parameter requires square brackets. However, an IPv6 address does not work with square brackets. An example of the correct syntax to use for an IPv6 address is nameserver=2001:db8::1 . bootdev= The bootdev= option specifies the boot interface. This option is mandatory if you use more than one ip option. ifname= The ifname= options assigns an interface name to a network device with a given MAC address. You can use this option multiple times. The syntax is ifname=interface:MAC . For example: Note The ifname= option is the only supported way to set custom network interface names during installation. inst.dhcpclass= The inst.dhcpclass= option specifies the DHCP vendor class identifier. The dhcpd service recognizes this value as vendor-class-identifier . The default value is anaconda-USD(uname -srm) . To ensure the inst.dhcpclass= option is applied correctly, request network activation during the early stage of installation by also adding the ip option. inst.waitfornet= Using the inst.waitfornet=SECONDS boot option causes the installation system to wait for network connectivity before installation. The value given in the SECONDS argument specifies the maximum amount of time to wait for network connectivity before timing out and continuing the installation process even if network connectivity is not present. vlan= Use the vlan= option to configure a Virtual LAN (VLAN) device on a specified interface with a given name. The syntax is vlan=name:interface . For example: This configures a VLAN device named vlan5 on the enp0s1 interface. The name can take the following forms: VLAN_PLUS_VID: vlan0005 VLAN_PLUS_VID_NO_PAD: vlan5 DEV_PLUS_VID: enp0s1.0005 DEV_PLUS_VID_NO_PAD: enp0s1.5 bond= Use the bond= option to configure a bonding device with the following syntax: bond=name[:interfaces][:options] . Replace name with the bonding device name, interfaces with a comma-separated list of physical (Ethernet) interfaces, and options with a comma-separated list of bonding options. For example: For a list of available options, execute the modinfo bonding command. team= Use the team= option to configure a team device with the following syntax: team=name:interfaces . Replace name with the desired name of the team device and interfaces with a comma-separated list of physical (Ethernet) devices to be used as underlying interfaces in the team device. For example: Important NIC teaming is deprecated in Red Hat Enterprise Linux 9. Consider using the network bonding driver as an alternative. For details, see Configuring a network bond . bridge= Use the bridge= option to configure a bridge device with the following syntax: bridge=name:interfaces . Replace name with the desired name of the bridge device and interfaces with a comma-separated list of physical (Ethernet) devices to be used as underlying interfaces in the bridge device. For example: Additional resources Configuring and managing networking C.3. Console boot options This section describes how to configure boot options for your console, monitor display, and keyboard. console= Use the console= option to specify a device that you want to use as the primary console. For example, to use a console on the first serial port, use console=ttyS0 . When using the console= argument, the installation starts with a text UI. If you must use the console= option multiple times, the boot message is displayed on all specified console. However, the installation program uses only the last specified console. For example, if you specify console=ttyS0 console=ttyS1 , the installation program uses ttyS1 . inst.lang= Use the inst.lang= option to set the language that you want to use during the installation. To view the list of locales, enter the command locale -a | grep _ or the localectl list-locales | grep _ command. inst.geoloc= Use the inst.geoloc= option to configure geolocation usage in the installation program. Geolocation is used to preset the language and time zone, and uses the following syntax: inst.geoloc=value . The value can be any of the following parameters: Disable geolocation: inst.geoloc=0 Use the Fedora GeoIP API: inst.geoloc=provider_fedora_geoip . This option is deprecated. Use the Hostip.info GeoIP API: inst.geoloc=provider_hostip . This option is deprecated. inst.keymap= Use the inst.keymap= option to specify the keyboard layout to use for the installation. inst.cmdline Use the inst.cmdline option to force the installation program to run in command-line mode. This mode does not allow any interaction, and you must specify all options in a Kickstart file or on the command line. inst.graphical Use the inst.graphical option to force the installation program to run in graphical mode. The graphical mode is the default. inst.text Use the inst.text option to force the installation program to run in text mode instead of graphical mode. inst.noninteractive Use the inst.noninteractive boot option to run the installation program in a non-interactive mode. User interaction is not permitted in the non-interactive mode, and inst.noninteractive you can use the inst.nointeractive option with a graphical or text installation. When you use the inst.noninteractive option in text mode, it behaves the same as the inst.cmdline option. inst.resolution= Use the inst.resolution= option to specify the screen resolution in graphical mode. The format is NxM , where N is the screen width and M is the screen height (in pixels). The recommended resolution is 1024x768. inst.vnc Use the inst.vnc option to run the graphical installation using Virtual Network Computing (VNC). You must use a VNC client application to interact with the installation program. When VNC sharing is enabled, multiple clients can connect. A system installed using VNC starts in text mode. inst.vncpassword= Use the inst.vncpassword= option to set a password on the VNC server that is used by the installation program. inst.vncconnect= Use the inst.vncconnect= option to connect to a listening VNC client at the given host location, for example, inst.vncconnect=<host>[:<port>] The default port is 5900. You can use this option by entering the command vncviewer -listen . inst.xdriver= Use the inst.xdriver= option to specify the name of the X driver to use both during installation and on the installed system. inst.usefbx Use the inst.usefbx option to prompt the installation program to use the frame buffer X driver instead of a hardware-specific driver. This option is equivalent to the inst.xdriver=fbdev option. modprobe.blacklist= Use the modprobe.blacklist= option to blocklist or completely disable one or more drivers. Drivers (mods) that you disable using this option cannot load when the installation starts. After the installation finishes, the installed system retains these settings. You can find a list of the blocklisted drivers in the /etc/modprobe.d/ directory. Use a comma-separated list to disable multiple drivers. For example: Note You can use modprobe.blacklist in combination with the different command line options. For example, use it with the inst.dd option to ensure that an updated version of an existing driver is loaded from a driver update disc: inst.xtimeout= Use the inst.xtimeout= option to specify the timeout in seconds for starting X server. inst.sshd Use the inst.sshd option to start the sshd service during installation, so that you can connect to the system during the installation using SSH, and monitor the installation progress. For more information about SSH, see the ssh(1) man page on your system. By default, the sshd option is automatically started only on the 64-bit IBM Z architecture. On other architectures, sshd is not started unless you use the inst.sshd option. Note During installation, the root account has no password by default. You can set a root password during installation with the sshpw Kickstart command. inst.kdump_addon= Use the inst.kdump_addon= option to enable or disable the Kdump configuration screen (add-on) in the installation program. This screen is enabled by default; use inst.kdump_addon=off to disable it. Disabling the add-on disables the Kdump screens in both the graphical and text-based interface as well as the %addon com_redhat_kdump Kickstart command. C.4. Debug boot options This section describes the options you can use when debugging issues. inst.rescue Use the inst.rescue option to run the rescue environment for diagnosing and fixing systems. For more information, see the Red Hat Knowledgebase solution repair a filesystem in rescue mode . inst.updates= Use the inst.updates= option to specify the location of the updates.img file that you want to apply during installation. The updates.img file can be derived from one of several sources. Table C.4. updates.img file sources Source Description Example Updates from a network Specify the network location of updates.img . This does not require any modification to the installation tree. To use this method, edit the kernel command line to include inst.updates . inst.updates=http://website.com/path/to/updates.img . Updates from a disk image Save an updates.img on a floppy drive or a USB key. This can be done only with an ext2 filesystem type of updates.img . To save the contents of the image on your floppy drive, insert the floppy disc and run the command. dd if=updates.img of=/dev/fd0 bs=72k count=20 . To use a USB key or flash media, replace /dev/fd0 with the device name of your USB flash drive. Updates from an installation tree If you are using a CD, disk, HTTP, or FTP install, save the updates.img in the installation tree so that all installations can detect the .img file. The file name must be updates.img . For NFS installs, save the file in the images/ directory, or in the RHupdates/ directory. inst.syslog= Sends log messages to the syslog process on the specified host when the installation starts. You can use inst.syslog= only if the remote syslog process is configured to accept incoming connections. inst.virtiolog= Use the inst.virtiolog= option to specify which virtio port (a character device at /dev/virtio-ports/name ) to use for forwarding logs. The default value is org.fedoraproject.anaconda.log.0 . rd.live.ram Copies the stage 2 image in images/install.img into RAM. Note that this increases the memory required for installation by the size of the image which is usually between 400 and 800MB. inst.nokill Prevent the installation program from rebooting when a fatal error occurs, or at the end of the installation process. Use it capture installation logs which would be lost upon reboot. inst.noshell Prevent a shell on terminal session 2 (tty2) during installation. inst.notmux Prevent the use of tmux during installation. The output is generated without terminal control characters and is meant for non-interactive uses. inst.remotelog= Sends all the logs to a remote host:port using a TCP connection. The connection is retired if there is no listener and the installation proceeds as normal. C.5. Storage boot options This section describes the options you can specify to customize booting from a storage device. inst.nodmraid Disables dmraid support. Warning Use this option with caution. If you have a disk that is incorrectly identified as part of a firmware RAID array, it might have some stale RAID metadata on it that must be removed using the appropriate tool such as, dmraid or wipefs . inst.nompath Disables support for multipath devices. Use this option only if your system has a false-positive that incorrectly identifies a normal block device as a multipath device. Warning Use this option with caution. Do not use this option with multipath hardware. Using this option to install to a single path of a multipath device is not supported. inst.gpt Forces the installation program to install partition information to a GUID Partition Table (GPT) instead of a Master Boot Record (MBR). This option is not valid on UEFI-based systems, unless they are in BIOS compatibility mode. Normally, BIOS-based systems and UEFI-based systems in BIOS compatibility mode attempt to use the MBR schema for storing partitioning information, unless the disk is 2^32 sectors in size or larger. Disk sectors are typically 512 bytes in size, meaning that this is usually equivalent to 2 TiB. The inst.gpt boot option allows a GPT to be written to smaller disks. inst.wait_for_disks= Use the inst.wait_for_disks= option to specify the number of seconds installation program to wait for disk devices to appear at the beginning of the installation. Use this option when you use the OEMDRV-labeled device to automatically load the Kickstart file or the kernel drivers but the device takes longer time to appear during the boot process. By default, installation program waits for 5 seconds. Use 0 seconds to minimize the delay. C.6. Deprecated boot options This section contains information about deprecated boot options. These options are still accepted by the installation program but they are deprecated and are scheduled to be removed in a future release of Red Hat Enterprise Linux. method The method option is an alias for inst.repo . dns Use nameserver instead of dns . Note that nameserver does not accept comma-separated lists; use multiple nameserver options instead. ksdevice Table C.5. Values for the ksdevice boot option Value Information Not present N/A ksdevice=link Ignored as this option is the same as the default behavior ksdevice=bootif Ignored as this option is the default if BOOTIF= is present ksdevice=ibft Replaced with ip=ibft . See ip for details ksdevice=<MAC> Replaced with BOOTIF=USD{MAC/:/-} ksdevice=<DEV> Replaced with bootdev C.7. Removed boot options This section contains the boot options that have been removed from Red Hat Enterprise Linux. Note dracut provides advanced boot options. For more information about dracut , see the dracut.cmdline(7) man page on your system. askmethod, asknetwork initramfs is completely non-interactive, so the askmethod and asknetwork options have been removed. Use inst.repo or specify the appropriate network options. blacklist, nofirewire The modprobe option now handles blocklisting kernel modules. Use modprobe.blacklist=<mod1>,<mod2> . You can blocklist the firewire module by using modprobe.blacklist=firewire_ohci . inst.headless= The headless= option specified that the system that is being installed to does not have any display hardware, and that the installation program is not required to look for any display hardware. inst.decorated The inst.decorated option was used to specify the graphical installation in a decorated window. By default, the window is not decorated, so it does not have a title bar, resize controls, and so on. This option was no longer required. repo=nfsiso Use the inst.repo=nfs: option. serial Use the console=ttyS0 option. updates Use the inst.updates option. essid, wepkey, wpakey Dracut does not support wireless networking. ethtool This option was no longer required. gdb This option was removed because many options are available for debugging dracut-based initramfs . inst.mediacheck Use the dracut option rd.live.check option. ks=floppy Use the inst.ks=hd:<device> option. display For a remote display of the UI, use the inst.vnc option. utf8 This option was no longer required because the default TERM setting behaves as expected. noipv6 ipv6 is built into the kernel and cannot be removed by the installation program. You can disable ipv6 by using ipv6.disable=1 . This setting is used by the installed system. upgradeany This option was no longer required because the installation program no longer handles upgrades. netmask, gateway, hostname The netmask , gateway , and hostname options are provided as part of the ip option. ip=bootif A PXE-supplied BOOTIF option is used automatically, so there is no requirement to use ip=bootif . inst.zram The zram.service cannot be run anymore. See zram-generator for more information. inst.singlelang The single language mode is not supported anymore. inst.repo=hd:<device>:<path> for installable tree This option cannot be used with installable tree but only with an ISO file. inst.loglevel The log level is always set to debug.
[ "inst.stage2=https://hostname/path_to_install_image/ inst.noverifyssl", "inst.repo=https://hostname/path_to_install_repository/ inst.noverifyssl", "inst.stage2.all inst.stage2=http://hostname1/path_to_install_tree/ inst.stage2=http://hostname2/path_to_install_tree/ inst.stage2=http://hostname3/path_to_install_tree/", "[PROTOCOL://][USERNAME[:PASSWORD]@]HOST[:PORT]", "inst.nosave=Input_ks,logs", "ifname=eth0:01:23:45:67:89:ab", "vlan=vlan5:enp0s1", "bond=bond0:enp0s1,enp0s2:mode=active-backup,tx_queues=32,downdelay=5000", "team=team0:enp0s1,enp0s2", "bridge=bridge0:enp0s1,enp0s2", "modprobe.blacklist=ahci,firewire_ohci", "modprobe.blacklist=virtio_blk" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/automatically_installing_rhel/custom-boot-options_rhel-installer
Chapter 5. The Redfish modules in RHEL
Chapter 5. The Redfish modules in RHEL The Redfish modules for remote management of devices are now part of the redhat.rhel_mgmt Ansible collection. With the Redfish modules, you can easily use management automation on bare-metal servers and platform hardware by getting information about the servers or control them through an Out-Of-Band (OOB) controller, using the standard HTTPS transport and JSON format. 5.1. The Redfish modules The redhat.rhel_mgmt Ansible collection provides the Redfish modules to support hardware management in Ansible over Redfish. The redhat.rhel_mgmt collection is available in the ansible-collection-redhat-rhel_mgmt package. To install it, see Installing the redhat.rhel_mgmt Collection using the CLI . The following Redfish modules are available in the redhat.rhel_mgmt collection: redfish_info : The redfish_info module retrieves information about the remote Out-Of-Band (OOB) controller such as systems inventory. redfish_command : The redfish_command module performs Out-Of-Band (OOB) controller operations like log management and user management, and power operations such as system restart, power on and off. redfish_config : The redfish_config module performs OOB controller operations such as changing OOB configuration, or setting the BIOS configuration. 5.2. Redfish modules parameters The parameters used for the Redfish modules are: redfish_info parameters: Description baseuri (Mandatory) - Base URI of OOB controller. category (Mandatory) - List of categories to execute on OOB controller. The default value is ["Systems"]. command (Mandatory) - List of commands to execute on OOB controller. username Username for authentication to OOB controller. password Password for authentication to OOB controller. redfish_command parameters: Description baseuri (Mandatory) - Base URI of OOB controller. category (Mandatory) - List of categories to execute on OOB controller. The default value is ["Systems"]. command (Mandatory) - List of commands to execute on OOB controller. username Username for authentication to OOB controller. password Password for authentication to OOB controller. redfish_config parameters: Description baseuri (Mandatory) - Base URI of OOB controller. category (Mandatory) - List of categories to execute on OOB controller. The default value is ["Systems"]. command (Mandatory) - List of commands to execute on OOB controller. username Username for authentication to OOB controller. password Password for authentication to OOB controller. bios_attributes BIOS attributes to update. 5.3. Using the redfish_info module The following example shows how to use the redfish_info module in a playbook to get information about the CPU inventory. For simplicity, the example uses the same host as the Ansible control host and managed host, thus executing the modules on the same host where the playbook is executed. Prerequisites You have prepared the control node and the managed nodes . You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. The ansible-collection-redhat-rhel_mgmt package is installed. The python3-pyghmi package is installed either on the control node or the managed nodes. OOB controller access details. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Manage out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Get CPU inventory redhat.rhel_mgmt.redfish_info: baseuri: " <URI> " username: " <username> " password: " <password> " category: Systems command: GetCpuInventory register: result Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification When you run the playbook, Ansible returns the CPU inventory details. Additional resources /usr/share/ansible/collections/ansible_collections/redhat/rhel_mgmt/README.md file 5.4. Using the redfish_command module The following example shows how to use the redfish_command module in a playbook to turn on a system. For simplicity, the example uses the same host as the Ansible control host and managed host, thus executing the modules on the same host where the playbook is executed. Prerequisites You have prepared the control node and the managed nodes . You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. The ansible-collection-redhat-rhel_mgmt package is installed. The python3-pyghmi package is installed either on the control node or the managed nodes. OOB controller access details. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Manage out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Power on system redhat.rhel_mgmt.redfish_command: baseuri: " <URI> " username: " <username> " password: " <password> " category: Systems command: PowerOn Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification The system powers on. Additional resources /usr/share/ansible/collections/ansible_collections/redhat/rhel_mgmt/README.md file 5.5. Using the redfish_config module The following example shows how to use the redfish_config module in a playbook to configure a system to boot with UEFI. For simplicity, the example uses the same host as the Ansible control host and managed host, thus executing the modules on the same host where the playbook is executed. Prerequisites You have prepared the control node and the managed nodes . You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. The ansible-collection-redhat-rhel_mgmt package is installed. The python3-pyghmi package is installed either on the control node or the managed nodes. OOB controller access details. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Manages out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Set BootMode to UEFI redhat.rhel_mgmt.redfish_config: baseuri: " <URI> " username: " <username> " password: " <password> " category: Systems command: SetBiosAttributes bios_attributes: BootMode: Uefi Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification The system boot mode is set to UEFI. Additional resources /usr/share/ansible/collections/ansible_collections/redhat/rhel_mgmt/README.md file
[ "--- - name: Manage out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Get CPU inventory redhat.rhel_mgmt.redfish_info: baseuri: \" <URI> \" username: \" <username> \" password: \" <password> \" category: Systems command: GetCpuInventory register: result", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml", "--- - name: Manage out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Power on system redhat.rhel_mgmt.redfish_command: baseuri: \" <URI> \" username: \" <username> \" password: \" <password> \" category: Systems command: PowerOn", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml", "--- - name: Manages out-of-band controllers using Redfish APIs hosts: managed-node-01.example.com tasks: - name: Set BootMode to UEFI redhat.rhel_mgmt.redfish_config: baseuri: \" <URI> \" username: \" <username> \" password: \" <password> \" category: Systems command: SetBiosAttributes bios_attributes: BootMode: Uefi", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/automating_system_administration_by_using_rhel_system_roles/assembly_the-redfish-modules-in-rhel_automating-system-administration-by-using-rhel-system-roles
Appendix I. Revision History
Appendix I. Revision History Note that revision numbers relate to the edition of this manual, not to version numbers of Red Hat Enterprise Linux. Revision History Revision 1.0-138 Tue Mar 14 2017 Petr Bokoc Asynchronous update. Revision 1.0-137 Tue Mar 14 2017 Petr Bokoc Red Hat Enterprise Linux 6.9 General Availability release. Revision 1.0-131 Tue Mar 11 2016 Clayton Spicer Red Hat Enterprise Linux 6.8 GA release. Revision 1.0-127 Fri 10 Jul 2015 Petr Bokoc Red Hat Enterprise Linux 6.7 GA release Revision 1.0-112 Wed Oct 08 2014 Petr Bokoc Red Hat Enterprise Linux 6.6 GA release Revision 1.0-102 Thu Nov 07 2013 Petr Bokoc Red Hat Enterprise Linux 6.5 GA release Revision 1.0-96 Tue Feb 19 2013 Jack Reed Second version for Red Hat Enterprise Linux 6.4 GA release Revision 1.0-95 Sun Feb 17 2013 Jack Reed Red Hat Enterprise Linux 6.4 GA release Revision 1.0-41 Thu May 19 2011 Rudiger Landmann Red Hat Enterprise Linux 6.1 GA release Revision 1.0-0 Wed Aug 25 2010 Rudiger Landmann Red Hat Enterprise Linux 6.0 GA release
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/installation_guide/appe-publican-revision_history
Introduction
Introduction This document provides information about installing, configuring and managing Red Hat High Availability Add-On components. Red Hat High Availability Add-On components allow you to connect a group of computers (called nodes or members ) to work together as a cluster. In this document, the use of the word cluster or clusters is used to refer to a group of computers running the Red Hat High Availability Add-On. The audience of this document should have advanced working knowledge of Red Hat Enterprise Linux and understand the concepts of clusters, storage, and server computing. For more information about Red Hat Enterprise Linux 6, see the following resources: Red Hat Enterprise Linux Installation Guide - Provides information regarding installation of Red Hat Enterprise Linux 6. Red Hat Enterprise Linux Deployment Guide - Provides information regarding the deployment, configuration and administration of Red Hat Enterprise Linux 6. For more information about the High Availability Add-On and related products for Red Hat Enterprise Linux 6, see the following resources: High Availability Add-On Overview - Provides a high-level overview of the Red Hat High Availability Add-On. Logical Volume Manager Administration - Provides a description of the Logical Volume Manager (LVM), including information on running LVM in a clustered environment. Global File System 2: Configuration and Administration - Provides information about installing, configuring, and maintaining Red Hat GFS2 (Red Hat Global File System 2), which is included in the Resilient Storage Add-On. DM Multipath - Provides information about using the Device-Mapper Multipath feature of Red Hat Enterprise Linux 6. Load Balancer Administration - Provides information on configuring high-performance systems and services with the Load Balancer Add-On, a set of integrated software components that provide Linux Virtual Servers (LVS) for balancing IP load across a set of real servers. Release Notes - Provides information about the current release of Red Hat products. Red Hat documents are available in HTML, PDF, and RPM versions online at https://access.redhat.com/documentation/en/red-hat-enterprise-linux/ . 1. Feedback If you spot a typo, or if you have thought of a way to make this manual better, we would love to hear from you. Please submit a report in Bugzilla: http://bugzilla.redhat.com/bugzilla/ . File the bug against the product Red Hat Enterprise Linux 6 and the component doc-Cluster_Administration . Be sure to mention the manual identifier: By mentioning this manual's identifier, we know exactly which version of the guide you have. If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the section number and some of the surrounding text so we can find it easily.
[ "Cluster_Administration(EN)-6 (2017-3-07T16:26)" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/cluster_administration/ch-intro-CA
7.2.2. Configuration changes for Windows virtual machines
7.2.2. Configuration changes for Windows virtual machines Warning Before converting Windows virtual machines, ensure that the libguestfs-winsupport and virtio-win packages are installed on the host running virt-v2v . These packages provide support for NTFS and Windows paravirtualized block and network drivers. If you attempt to convert a virtual machine using NTFS without the libguestfs-winsupport package installed, the conversion will fail. If you attempt to convert a virtual machine running Windows without the virtio-win package installed, the conversion will fail giving an error message concerning missing files. See Section 4.3.1.2, "Preparing to convert a virtual machine running Windows" for details. virt-v2v can convert virtual machines running Windows XP, Windows Vista, Windows 7, Windows Server 2003 and Windows Server 2008. The conversion process for virtual machines running Windows is slightly to different to the process for virtual machines running Linux. Windows virtual machine images are converted as follows: virt-v2v installs VirtIO block drivers. virt-v2v installs the CDUpgrader utility. virt-v2v copies VirtIO block and network drivers to %SystemRoot%\Drivers\VirtIO . The virtio-win package does not include network drivers for Windows 7 and Windows XP. For those operating systems, the rtl8139 network drivers are used. rtl8139 support must be already available in the guest virtual machine. virt-v2v adds %SystemRoot%\Drivers\VirtIO to DevicePath , meaning this directory is automatically searched for drivers when a new device is detected. virt-v2v makes registry changes to include the VirtIO block drivers in the CriticalDeviceDatabase section of the registry, and ensure the CDUpgrader service is started at the boot. At this point, virt-v2v has completed the conversion. The converted virtual machine is now fully functional, and the conversion is complete for output to KVM managed by libvirt. If the virtual machine is being converted for output to Red Hat Enterprise Virtualization, the Red Hat Enterprise Virtualization Manager will perform additional steps to complete the conversion: The virtual machine is imported and run on the Manager. See the Red Hat Enterprise Virtualization Administration Guide for details. Important The first boot stage can take several minutes to run, and must not be interrupted. It will run automatically without any administrator intervention other than starting the virtual machine. To ensure the process is not interrupted, no user should log in to the virtual machine until it has quiesced. You can check for this in the Manager GUI. If the guest tools ISO has been uploaded to the Manager, as detailed in Section 4.3.1.2, "Preparing to convert a virtual machine running Windows" , the Manager attaches the guest tools CD to the virtual machine. CDUpgrader detects the guest tools ISO and installs all the VirtIO drivers from it, including additional tools that are not included in virtio-win . The VirtIO drivers are reinstalled if the drivers in the guest tools ISO are newer than the ones previously installed from virtio-win . This ensures that the tools are kept up to date.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/v2v_guide/sect-V2V_Guide-Configuration_Changes-Configuration_Changes_for_Windows_Virtual_Machines
Chapter 15. Managing security context constraints
Chapter 15. Managing security context constraints 15.1. About security context constraints Similar to the way that RBAC resources control user access, administrators can use security context constraints (SCCs) to control permissions for pods. These permissions include actions that a pod can perform and what resources it can access. You can use SCCs to define a set of conditions that a pod must run with to be accepted into the system. Security context constraints allow an administrator to control: Whether a pod can run privileged containers with the allowPrivilegedContainer flag. Whether a pod is constrained with the allowPrivilegeEscalation flag. The capabilities that a container can request The use of host directories as volumes The SELinux context of the container The container user ID The use of host namespaces and networking The allocation of an FSGroup that owns the pod volumes The configuration of allowable supplemental groups Whether a container requires write access to its root file system The usage of volume types The configuration of allowable seccomp profiles Important Do not set the openshift.io/run-level label on any namespaces in OpenShift Container Platform. This label is for use by internal OpenShift Container Platform components to manage the startup of major API groups, such as the Kubernetes API server and OpenShift API server. If the openshift.io/run-level label is set, no SCCs are applied to pods in that namespace, causing any workloads running in that namespace to be highly privileged. 15.1.1. Default security context constraints The cluster contains several default security context constraints (SCCs) as described in the table below. Additional SCCs might be installed when you install Operators or other components to OpenShift Container Platform. Important Do not modify the default SCCs. Customizing the default SCCs can lead to issues when some of the platform pods deploy or OpenShift Container Platform is upgraded. During upgrades between some versions of OpenShift Container Platform, the values of the default SCCs are reset to the default values, which discards all customizations to those SCCs. Instead, create new SCCs as needed. Table 15.1. Default security context constraints Security context constraint Description anyuid Provides all features of the restricted SCC, but allows users to run with any UID and any GID. hostaccess Allows access to all host namespaces but still requires pods to be run with a UID and SELinux context that are allocated to the namespace. Warning This SCC allows host access to namespaces, file systems, and PIDs. It should only be used by trusted pods. Grant with caution. hostmount-anyuid Provides all the features of the restricted SCC, but allows host mounts and running as any UID and any GID on the system. Warning This SCC allows host file system access as any UID, including UID 0. Grant with caution. hostnetwork Allows using host networking and host ports but still requires pods to be run with a UID and SELinux context that are allocated to the namespace. Warning If additional workloads are run on control plane hosts (also known as the master hosts), use caution when providing access to hostnetwork . A workload that runs hostnetwork on a control plane host is effectively root on the cluster and must be trusted accordingly. node-exporter Used for the Prometheus node exporter. Warning This SCC allows host file system access as any UID, including UID 0. Grant with caution. nonroot Provides all features of the restricted SCC, but allows users to run with any non-root UID. The user must specify the UID or it must be specified in the manifest of the container runtime. privileged Allows access to all privileged and host features and the ability to run as any user, any group, any FSGroup, and with any SELinux context. Warning This is the most relaxed SCC and should be used only for cluster administration. Grant with caution. The privileged SCC allows: Users to run privileged pods Pods to mount host directories as volumes Pods to run as any user Pods to run with any MCS label Pods to use the host's IPC namespace Pods to use the host's PID namespace Pods to use any FSGroup Pods to use any supplemental group Pods to use any seccomp profiles Pods to request any capabilities Note Setting privileged: true in the pod specification does not necessarily select the privileged SCC. The SCC that has allowPrivilegedContainer: true and has the highest prioritization will be chosen if the user has the permissions to use it. restricted Denies access to all host features and requires pods to be run with a UID, and SELinux context that are allocated to the namespace. This is the most restrictive SCC provided by a new installation and will be used by default for authenticated users. The restricted SCC: Ensures that pods cannot run as privileged Ensures that pods cannot mount host directory volumes Requires that a pod is run as a user in a pre-allocated range of UIDs Requires that a pod is run with a pre-allocated MCS label Allows pods to use any FSGroup Allows pods to use any supplemental group Note The restricted SCC is the most restrictive of the SCCs that ship by default with the system. However, you can create a custom SCC that is even more restrictive. For example, you can create an SCC that restricts readOnlyRootFS to true and allowPrivilegeEscalation to false . 15.1.2. Security context constraints settings Security context constraints (SCCs) are composed of settings and strategies that control the security features a pod has access to. These settings fall into three categories: Category Description Controlled by a boolean Fields of this type default to the most restrictive value. For example, AllowPrivilegedContainer is always set to false if unspecified. Controlled by an allowable set Fields of this type are checked against the set to ensure their value is allowed. Controlled by a strategy Items that have a strategy to generate a value provide: A mechanism to generate the value, and A mechanism to ensure that a specified value falls into the set of allowable values. CRI-O has the following default list of capabilities that are allowed for each container of a pod: CHOWN DAC_OVERRIDE FSETID FOWNER SETGID SETUID SETPCAP NET_BIND_SERVICE KILL The containers use the capabilities from this default list, but pod manifest authors can alter it by requesting additional capabilities or removing some of the default behaviors. Use the allowedCapabilities , defaultAddCapabilities , and requiredDropCapabilities parameters to control such requests from the pods and to dictate which capabilities can be requested, which ones must be added to each container, and which ones must be forbidden. 15.1.3. Security context constraints strategies RunAsUser MustRunAs - Requires a runAsUser to be configured. Uses the configured runAsUser as the default. Validates against the configured runAsUser . MustRunAsRange - Requires minimum and maximum values to be defined if not using pre-allocated values. Uses the minimum as the default. Validates against the entire allowable range. MustRunAsNonRoot - Requires that the pod be submitted with a non-zero runAsUser or have the USER directive defined in the image. No default provided. RunAsAny - No default provided. Allows any runAsUser to be specified. SELinuxContext MustRunAs - Requires seLinuxOptions to be configured if not using pre-allocated values. Uses seLinuxOptions as the default. Validates against seLinuxOptions . RunAsAny - No default provided. Allows any seLinuxOptions to be specified. SupplementalGroups MustRunAs - Requires at least one range to be specified if not using pre-allocated values. Uses the minimum value of the first range as the default. Validates against all ranges. RunAsAny - No default provided. Allows any supplementalGroups to be specified. FSGroup MustRunAs - Requires at least one range to be specified if not using pre-allocated values. Uses the minimum value of the first range as the default. Validates against the first ID in the first range. RunAsAny - No default provided. Allows any fsGroup ID to be specified. 15.1.4. Controlling volumes The usage of specific volume types can be controlled by setting the volumes field of the SCC. The allowable values of this field correspond to the volume sources that are defined when creating a volume: awsElasticBlockStore azureDisk azureFile cephFS cinder configMap downwardAPI emptyDir fc flexVolume flocker gcePersistentDisk gitRepo glusterfs hostPath iscsi nfs persistentVolumeClaim photonPersistentDisk portworxVolume projected quobyte rbd scaleIO secret storageos vsphereVolume * (A special value to allow the use of all volume types.) none (A special value to disallow the use of all volumes types. Exists only for backwards compatibility.) The recommended minimum set of allowed volumes for new SCCs are configMap , downwardAPI , emptyDir , persistentVolumeClaim , secret , and projected . Note This list of allowable volume types is not exhaustive because new types are added with each release of OpenShift Container Platform. Note For backwards compatibility, the usage of allowHostDirVolumePlugin overrides settings in the volumes field. For example, if allowHostDirVolumePlugin is set to false but allowed in the volumes field, then the hostPath value will be removed from volumes . 15.1.5. Admission control Admission control with SCCs allows for control over the creation of resources based on the capabilities granted to a user. In terms of the SCCs, this means that an admission controller can inspect the user information made available in the context to retrieve an appropriate set of SCCs. Doing so ensures the pod is authorized to make requests about its operating environment or to generate a set of constraints to apply to the pod. The set of SCCs that admission uses to authorize a pod are determined by the user identity and groups that the user belongs to. Additionally, if the pod specifies a service account, the set of allowable SCCs includes any constraints accessible to the service account. Admission uses the following approach to create the final security context for the pod: Retrieve all SCCs available for use. Generate field values for security context settings that were not specified on the request. Validate the final settings against the available constraints. If a matching set of constraints is found, then the pod is accepted. If the request cannot be matched to an SCC, the pod is rejected. A pod must validate every field against the SCC. The following are examples for just two of the fields that must be validated: Note These examples are in the context of a strategy using the pre-allocated values. An FSGroup SCC strategy of MustRunAs If the pod defines a fsGroup ID, then that ID must equal the default fsGroup ID. Otherwise, the pod is not validated by that SCC and the SCC is evaluated. If the SecurityContextConstraints.fsGroup field has value RunAsAny and the pod specification omits the Pod.spec.securityContext.fsGroup , then this field is considered valid. Note that it is possible that during validation, other SCC settings will reject other pod fields and thus cause the pod to fail. A SupplementalGroups SCC strategy of MustRunAs If the pod specification defines one or more supplementalGroups IDs, then the pod's IDs must equal one of the IDs in the namespace's openshift.io/sa.scc.supplemental-groups annotation. Otherwise, the pod is not validated by that SCC and the SCC is evaluated. If the SecurityContextConstraints.supplementalGroups field has value RunAsAny and the pod specification omits the Pod.spec.securityContext.supplementalGroups , then this field is considered valid. Note that it is possible that during validation, other SCC settings will reject other pod fields and thus cause the pod to fail. 15.1.6. Security context constraints prioritization Security context constraints (SCCs) have a priority field that affects the ordering when attempting to validate a request by the admission controller. A higher priority SCC is moved to the front of the set when sorting. When the complete set of available SCCs are determined they are ordered by: Highest priority first, nil is considered a 0 priority If priorities are equal, the SCCs will be sorted from most restrictive to least restrictive If both priorities and restrictions are equal the SCCs will be sorted by name By default, the anyuid SCC granted to cluster administrators is given priority in their SCC set. This allows cluster administrators to run pods as any user by without specifying a RunAsUser on the pod's SecurityContext . The administrator may still specify a RunAsUser if they wish. 15.2. About pre-allocated security context constraints values The admission controller is aware of certain conditions in the security context constraints (SCCs) that trigger it to look up pre-allocated values from a namespace and populate the SCC before processing the pod. Each SCC strategy is evaluated independently of other strategies, with the pre-allocated values, where allowed, for each policy aggregated with pod specification values to make the final values for the various IDs defined in the running pod. The following SCCs cause the admission controller to look for pre-allocated values when no ranges are defined in the pod specification: A RunAsUser strategy of MustRunAsRange with no minimum or maximum set. Admission looks for the openshift.io/sa.scc.uid-range annotation to populate range fields. An SELinuxContext strategy of MustRunAs with no level set. Admission looks for the openshift.io/sa.scc.mcs annotation to populate the level. A FSGroup strategy of MustRunAs . Admission looks for the openshift.io/sa.scc.supplemental-groups annotation. A SupplementalGroups strategy of MustRunAs . Admission looks for the openshift.io/sa.scc.supplemental-groups annotation. During the generation phase, the security context provider uses default values for any parameter values that are not specifically set in the pod. Default values are based on the selected strategy: RunAsAny and MustRunAsNonRoot strategies do not provide default values. If the pod needs a parameter value, such as a group ID, you must define the value in the pod specification. MustRunAs (single value) strategies provide a default value that is always used. For example, for group IDs, even if the pod specification defines its own ID value, the namespace's default parameter value also appears in the pod's groups. MustRunAsRange and MustRunAs (range-based) strategies provide the minimum value of the range. As with a single value MustRunAs strategy, the namespace's default parameter value appears in the running pod. If a range-based strategy is configurable with multiple ranges, it provides the minimum value of the first configured range. Note FSGroup and SupplementalGroups strategies fall back to the openshift.io/sa.scc.uid-range annotation if the openshift.io/sa.scc.supplemental-groups annotation does not exist on the namespace. If neither exists, the SCC is not created. Note By default, the annotation-based FSGroup strategy configures itself with a single range based on the minimum value for the annotation. For example, if your annotation reads 1/3 , the FSGroup strategy configures itself with a minimum and maximum value of 1 . If you want to allow more groups to be accepted for the FSGroup field, you can configure a custom SCC that does not use the annotation. Note The openshift.io/sa.scc.supplemental-groups annotation accepts a comma-delimited list of blocks in the format of <start>/<length or <start>-<end> . The openshift.io/sa.scc.uid-range annotation accepts only a single block. 15.3. Example security context constraints The following examples show the security context constraints (SCC) format and annotations: Annotated privileged SCC allowHostDirVolumePlugin: true allowHostIPC: true allowHostNetwork: true allowHostPID: true allowHostPorts: true allowPrivilegedContainer: true allowedCapabilities: 1 - '*' apiVersion: security.openshift.io/v1 defaultAddCapabilities: [] 2 fsGroup: 3 type: RunAsAny groups: 4 - system:cluster-admins - system:nodes kind: SecurityContextConstraints metadata: annotations: kubernetes.io/description: 'privileged allows access to all privileged and host features and the ability to run as any user, any group, any fsGroup, and with any SELinux context. WARNING: this is the most relaxed SCC and should be used only for cluster administration. Grant with caution.' creationTimestamp: null name: privileged priority: null readOnlyRootFilesystem: false requiredDropCapabilities: [] 5 runAsUser: 6 type: RunAsAny seLinuxContext: 7 type: RunAsAny seccompProfiles: - '*' supplementalGroups: 8 type: RunAsAny users: 9 - system:serviceaccount:default:registry - system:serviceaccount:default:router - system:serviceaccount:openshift-infra:build-controller volumes: - '*' 1 A list of capabilities that a pod can request. An empty list means that none of capabilities can be requested while the special symbol * allows any capabilities. 2 A list of additional capabilities that are added to any pod. 3 The FSGroup strategy, which dictates the allowable values for the security context. 4 The groups that can access this SCC. 5 A list of capabilities that are be dropped from a pod. 6 The runAsUser strategy type, which dictates the allowable values for the Security Context. 7 The seLinuxContext strategy type, which dictates the allowable values for the Security Context. 8 The supplementalGroups strategy, which dictates the allowable supplemental groups for the Security Context. 9 The users who can access this SCC. The users and groups fields on the SCC control which users can access the SCC. By default, cluster administrators, nodes, and the build controller are granted access to the privileged SCC. All authenticated users are granted access to the restricted SCC. Without explicit runAsUser setting apiVersion: v1 kind: Pod metadata: name: security-context-demo spec: securityContext: 1 containers: - name: sec-ctx-demo image: gcr.io/google-samples/node-hello:1.0 1 When a container or pod does not request a user ID under which it should be run, the effective UID depends on the SCC that emits this pod. Because restricted SCC is granted to all authenticated users by default, it will be available to all users and service accounts and used in most cases. The restricted SCC uses MustRunAsRange strategy for constraining and defaulting the possible values of the securityContext.runAsUser field. The admission plug-in will look for the openshift.io/sa.scc.uid-range annotation on the current project to populate range fields, as it does not provide this range. In the end, a container will have runAsUser equal to the first value of the range that is hard to predict because every project has different ranges. With explicit runAsUser setting apiVersion: v1 kind: Pod metadata: name: security-context-demo spec: securityContext: runAsUser: 1000 1 containers: - name: sec-ctx-demo image: gcr.io/google-samples/node-hello:1.0 1 A container or pod that requests a specific user ID will be accepted by OpenShift Container Platform only when a service account or a user is granted access to a SCC that allows such a user ID. The SCC can allow arbitrary IDs, an ID that falls into a range, or the exact user ID specific to the request. This configuration is valid for SELinux, fsGroup, and Supplemental Groups. 15.4. Creating security context constraints You can create security context constraints (SCCs) by using the OpenShift CLI ( oc ). Prerequisites Install the OpenShift CLI ( oc ). Log in to the cluster as a user with the cluster-admin role. Procedure Define the SCC in a YAML file named scc_admin.yaml : SecurityContextConstraints object definition kind: SecurityContextConstraints apiVersion: security.openshift.io/v1 metadata: name: scc-admin allowPrivilegedContainer: true runAsUser: type: RunAsAny seLinuxContext: type: RunAsAny fsGroup: type: RunAsAny supplementalGroups: type: RunAsAny users: - my-admin-user groups: - my-admin-group Optionally, you can specify drop capabilities for an SCC by setting the requiredDropCapabilities field with the desired values. Any specified capabilities are dropped from the container. For example, to create an SCC with the KILL , MKNOD , and SYS_CHROOT required drop capabilities, add the following to the SCC object: requiredDropCapabilities: - KILL - MKNOD - SYS_CHROOT CRI-O supports the same list of capability values that are found in the Docker documentation . Create the SCC by passing in the file: USD oc create -f scc_admin.yaml Example output securitycontextconstraints "scc-admin" created Verification Verify that the SCC was created: USD oc get scc scc-admin Example output NAME PRIV CAPS SELINUX RUNASUSER FSGROUP SUPGROUP PRIORITY READONLYROOTFS VOLUMES scc-admin true [] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [awsElasticBlockStore azureDisk azureFile cephFS cinder configMap downwardAPI emptyDir fc flexVolume flocker gcePersistentDisk gitRepo glusterfs iscsi nfs persistentVolumeClaim photonPersistentDisk quobyte rbd secret vsphere] 15.5. Role-based access to security context constraints You can specify SCCs as resources that are handled by RBAC. This allows you to scope access to your SCCs to a certain project or to the entire cluster. Assigning users, groups, or service accounts directly to an SCC retains cluster-wide scope. Note You cannot assign a SCC to pods created in one of the default namespaces: default , kube-system , kube-public , openshift-node , openshift-infra , openshift . These namespaces should not be used for running pods or services. To include access to SCCs for your role, specify the scc resource when creating a role. USD oc create role <role-name> --verb=use --resource=scc --resource-name=<scc-name> -n <namespace> This results in the following role definition: apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: ... name: role-name 1 namespace: namespace 2 ... rules: - apiGroups: - security.openshift.io 3 resourceNames: - scc-name 4 resources: - securitycontextconstraints 5 verbs: 6 - use 1 The role's name. 2 Namespace of the defined role. Defaults to default if not specified. 3 The API group that includes the SecurityContextConstraints resource. Automatically defined when scc is specified as a resource. 4 An example name for an SCC you want to have access. 5 Name of the resource group that allows users to specify SCC names in the resourceNames field. 6 A list of verbs to apply to the role. A local or cluster role with such a rule allows the subjects that are bound to it with a role binding or a cluster role binding to use the user-defined SCC called scc-name . Note Because RBAC is designed to prevent escalation, even project administrators are unable to grant access to an SCC. By default, they are not allowed to use the verb use on SCC resources, including the restricted SCC. 15.6. Reference of security context constraints commands You can manage security context constraints (SCCs) in your instance as normal API objects using the OpenShift CLI ( oc ). Note You must have cluster-admin privileges to manage SCCs. 15.6.1. Listing security context constraints To get a current list of SCCs: USD oc get scc Example output NAME PRIV CAPS SELINUX RUNASUSER FSGROUP SUPGROUP PRIORITY READONLYROOTFS VOLUMES anyuid false [] MustRunAs RunAsAny RunAsAny RunAsAny 10 false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] hostaccess false [] MustRunAs MustRunAsRange MustRunAs RunAsAny <none> false [configMap downwardAPI emptyDir hostPath persistentVolumeClaim projected secret] hostmount-anyuid false [] MustRunAs RunAsAny RunAsAny RunAsAny <none> false [configMap downwardAPI emptyDir hostPath nfs persistentVolumeClaim projected secret] hostnetwork false [] MustRunAs MustRunAsRange MustRunAs MustRunAs <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] node-exporter false [] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [*] nonroot false [] MustRunAs MustRunAsNonRoot RunAsAny RunAsAny <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] privileged true [*] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [*] restricted false [] MustRunAs MustRunAsRange MustRunAs RunAsAny <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] 15.6.2. Examining security context constraints You can view information about a particular SCC, including which users, service accounts, and groups the SCC is applied to. For example, to examine the restricted SCC: USD oc describe scc restricted Example output Name: restricted Priority: <none> Access: Users: <none> 1 Groups: system:authenticated 2 Settings: Allow Privileged: false Default Add Capabilities: <none> Required Drop Capabilities: KILL,MKNOD,SYS_CHROOT,SETUID,SETGID Allowed Capabilities: <none> Allowed Seccomp Profiles: <none> Allowed Volume Types: configMap,downwardAPI,emptyDir,persistentVolumeClaim,projected,secret Allow Host Network: false Allow Host Ports: false Allow Host PID: false Allow Host IPC: false Read Only Root Filesystem: false Run As User Strategy: MustRunAsRange UID: <none> UID Range Min: <none> UID Range Max: <none> SELinux Context Strategy: MustRunAs User: <none> Role: <none> Type: <none> Level: <none> FSGroup Strategy: MustRunAs Ranges: <none> Supplemental Groups Strategy: RunAsAny Ranges: <none> 1 Lists which users and service accounts the SCC is applied to. 2 Lists which groups the SCC is applied to. Note To preserve customized SCCs during upgrades, do not edit settings on the default SCCs. 15.6.3. Deleting security context constraints To delete an SCC: USD oc delete scc <scc_name> Note If you delete a default SCC, it will regenerate when you restart the cluster. 15.6.4. Updating security context constraints To update an existing SCC: USD oc edit scc <scc_name> Note To preserve customized SCCs during upgrades, do not edit settings on the default SCCs.
[ "allowHostDirVolumePlugin: true allowHostIPC: true allowHostNetwork: true allowHostPID: true allowHostPorts: true allowPrivilegedContainer: true allowedCapabilities: 1 - '*' apiVersion: security.openshift.io/v1 defaultAddCapabilities: [] 2 fsGroup: 3 type: RunAsAny groups: 4 - system:cluster-admins - system:nodes kind: SecurityContextConstraints metadata: annotations: kubernetes.io/description: 'privileged allows access to all privileged and host features and the ability to run as any user, any group, any fsGroup, and with any SELinux context. WARNING: this is the most relaxed SCC and should be used only for cluster administration. Grant with caution.' creationTimestamp: null name: privileged priority: null readOnlyRootFilesystem: false requiredDropCapabilities: [] 5 runAsUser: 6 type: RunAsAny seLinuxContext: 7 type: RunAsAny seccompProfiles: - '*' supplementalGroups: 8 type: RunAsAny users: 9 - system:serviceaccount:default:registry - system:serviceaccount:default:router - system:serviceaccount:openshift-infra:build-controller volumes: - '*'", "apiVersion: v1 kind: Pod metadata: name: security-context-demo spec: securityContext: 1 containers: - name: sec-ctx-demo image: gcr.io/google-samples/node-hello:1.0", "apiVersion: v1 kind: Pod metadata: name: security-context-demo spec: securityContext: runAsUser: 1000 1 containers: - name: sec-ctx-demo image: gcr.io/google-samples/node-hello:1.0", "kind: SecurityContextConstraints apiVersion: security.openshift.io/v1 metadata: name: scc-admin allowPrivilegedContainer: true runAsUser: type: RunAsAny seLinuxContext: type: RunAsAny fsGroup: type: RunAsAny supplementalGroups: type: RunAsAny users: - my-admin-user groups: - my-admin-group", "requiredDropCapabilities: - KILL - MKNOD - SYS_CHROOT", "oc create -f scc_admin.yaml", "securitycontextconstraints \"scc-admin\" created", "oc get scc scc-admin", "NAME PRIV CAPS SELINUX RUNASUSER FSGROUP SUPGROUP PRIORITY READONLYROOTFS VOLUMES scc-admin true [] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [awsElasticBlockStore azureDisk azureFile cephFS cinder configMap downwardAPI emptyDir fc flexVolume flocker gcePersistentDisk gitRepo glusterfs iscsi nfs persistentVolumeClaim photonPersistentDisk quobyte rbd secret vsphere]", "oc create role <role-name> --verb=use --resource=scc --resource-name=<scc-name> -n <namespace>", "apiVersion: rbac.authorization.k8s.io/v1 kind: Role metadata: name: role-name 1 namespace: namespace 2 rules: - apiGroups: - security.openshift.io 3 resourceNames: - scc-name 4 resources: - securitycontextconstraints 5 verbs: 6 - use", "oc get scc", "NAME PRIV CAPS SELINUX RUNASUSER FSGROUP SUPGROUP PRIORITY READONLYROOTFS VOLUMES anyuid false [] MustRunAs RunAsAny RunAsAny RunAsAny 10 false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] hostaccess false [] MustRunAs MustRunAsRange MustRunAs RunAsAny <none> false [configMap downwardAPI emptyDir hostPath persistentVolumeClaim projected secret] hostmount-anyuid false [] MustRunAs RunAsAny RunAsAny RunAsAny <none> false [configMap downwardAPI emptyDir hostPath nfs persistentVolumeClaim projected secret] hostnetwork false [] MustRunAs MustRunAsRange MustRunAs MustRunAs <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] node-exporter false [] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [*] nonroot false [] MustRunAs MustRunAsNonRoot RunAsAny RunAsAny <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret] privileged true [*] RunAsAny RunAsAny RunAsAny RunAsAny <none> false [*] restricted false [] MustRunAs MustRunAsRange MustRunAs RunAsAny <none> false [configMap downwardAPI emptyDir persistentVolumeClaim projected secret]", "oc describe scc restricted", "Name: restricted Priority: <none> Access: Users: <none> 1 Groups: system:authenticated 2 Settings: Allow Privileged: false Default Add Capabilities: <none> Required Drop Capabilities: KILL,MKNOD,SYS_CHROOT,SETUID,SETGID Allowed Capabilities: <none> Allowed Seccomp Profiles: <none> Allowed Volume Types: configMap,downwardAPI,emptyDir,persistentVolumeClaim,projected,secret Allow Host Network: false Allow Host Ports: false Allow Host PID: false Allow Host IPC: false Read Only Root Filesystem: false Run As User Strategy: MustRunAsRange UID: <none> UID Range Min: <none> UID Range Max: <none> SELinux Context Strategy: MustRunAs User: <none> Role: <none> Type: <none> Level: <none> FSGroup Strategy: MustRunAs Ranges: <none> Supplemental Groups Strategy: RunAsAny Ranges: <none>", "oc delete scc <scc_name>", "oc edit scc <scc_name>" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.7/html/authentication_and_authorization/managing-pod-security-policies
Chapter 3. Deployment of the Ceph File System
Chapter 3. Deployment of the Ceph File System As a storage administrator, you can deploy Ceph File Systems (CephFS) in a storage environment and have clients mount those Ceph File Systems to meet the storage needs. Basically, the deployment workflow is three steps: Create Ceph File Systems on a Ceph Monitor node. Create a Ceph client user with the appropriate capabilities, and make the client key available on the node where the Ceph File System will be mounted. Mount CephFS on a dedicated node, using either a kernel client or a File System in User Space (FUSE) client. Prerequisites A running, and healthy Red Hat Ceph Storage cluster. Installation and configuration of the Ceph Metadata Server daemon ( ceph-mds ). 3.1. Layout, quota, snapshot, and network restrictions These user capabilities can help you restrict access to a Ceph File System (CephFS) based on the needed requirements. Important All user capability flags, except rw , must be specified in alphabetical order. Layouts and Quotas When using layouts or quotas, clients require the p flag, in addition to rw capabilities. Setting the p flag restricts all the attributes being set by special extended attributes, those with a ceph. prefix. Also, this restricts other means of setting these fields, such as openc operations with layouts. Example In this example, client.0 can modify layouts and quotas on the file system cephfs_a , but client.1 cannot. Snapshots When creating or deleting snapshots, clients require the s flag, in addition to rw capabilities. When the capability string also contains the p flag, the s flag must appear after it. Example In this example, client.0 can create or delete snapshots in the temp directory of file system cephfs_a . Network Restricting clients connecting from a particular network. Example The optional network and prefix length is in CIDR notation, for example, 10.3.0.0/16 . Additional Resources See the Creating client users for a Ceph File System section in the Red Hat Ceph Storage File System Guide for details on setting the Ceph user capabilities. 3.2. Creating Ceph File Systems You can create multiple Ceph File Systems (CephFS) on a Ceph Monitor node. Prerequisites A running, and healthy Red Hat Ceph Storage cluster. Installation and configuration of the Ceph Metadata Server daemon ( ceph-mds ). Root-level access to a Ceph Monitor node. Root-level access to a Ceph client node. Procedure Configure the client node to use the Ceph storage cluster. Enable the Red Hat Ceph Storage Tools repository: Red Hat Enterprise Linux 8 Red Hat Enterprise Linux 9 Install the ceph-fuse package: Copy the Ceph client keyring from the Ceph Monitor node to the client node: Syntax Replace MONITOR_NODE_NAME with the Ceph Monitor host name or IP address. Example Copy the Ceph configuration file from a Ceph Monitor node to the client node: Syntax Replace MONITOR_NODE_NAME with the Ceph Monitor host name or IP address. Example Set the appropriate permissions for the configuration file: Create a Ceph File System: Syntax Example Repeat this step to create additional file systems. Note By running this command, Ceph automatically creates the new pools, and deploys a new Ceph Metadata Server (MDS) daemon to support the new file system. This also configures the MDS affinity accordingly. Verify access to the new Ceph File System from a Ceph client. Authorize a Ceph client to access the new file system: Syntax Example Note Optionally, you can add a safety measure by specifying the root_squash option. This prevents accidental deletion scenarios by disallowing clients with a uid=0 or gid=0 to do write operations, but still allows read operations. Example In this example, root_squash is enabled for the file system cephfs01 , except within the /volumes directory tree. Important The Ceph client can only see the CephFS it is authorized for. Copy the Ceph user's keyring to the Ceph client node: Syntax Example On the Ceph client node, create a new directory: Syntax Example On the Ceph client node, mount the new Ceph File System: Syntax Example On the Ceph client node, list the directory contents of the new mount point, or create a file on the new mount point. Additional Resources See the Creating client users for a Ceph File System section in the Red Hat Ceph Storage File System Guide for more details. See the Mounting the Ceph File System as a kernel client section in the Red Hat Ceph Storage File System Guide for more details. See the Mounting the Ceph File System as a FUSE client section in the Red Hat Ceph Storage File System Guide for more details. See Ceph File System limitations and the POSIX standards section in the Red Hat Ceph Storage File System Guide for more details. See the Pools chapter in the Red Hat Ceph Storage Storage Strategies Guide for more details. 3.3. Adding an erasure-coded pool to a Ceph File System By default, Ceph uses replicated pools for data pools. You can also add an additional erasure-coded data pool to the Ceph File System, if needed. Ceph File Systems (CephFS) backed by erasure-coded pools use less overall storage compared to Ceph File Systems backed by replicated pools. While erasure-coded pools use less overall storage, they also use more memory and processor resources than replicated pools. Important CephFS EC pools are for archival purpose only. Important For production environments, Red Hat recommends using the default replicated data pool for CephFS. The creation of inodes in CephFS creates at least one object in the default data pool. It is better to use a replicated pool for the default data to improve small-object write performance, and to improve read performance for updating backtraces. Prerequisites A running Red Hat Ceph Storage cluster. An existing Ceph File System. Pools using BlueStore OSDs. Root-level access to a Ceph Monitor node. Installation of the attr package. Procedure Create an erasure-coded data pool for CephFS: Syntax Example Verify the pool was added: Example Enable overwrites on the erasure-coded pool: Syntax Example Verify the status of the Ceph File System: Syntax Example Add the erasure-coded data pool to the existing CephFS: Syntax Example This example adds the new data pool, cephfs-data-ec01 , to the existing erasure-coded file system, cephfs-ec . Verify that the erasure-coded pool was added to the Ceph File System: Syntax Example Set the file layout on a new directory: Syntax Example In this example, all new files created in the /mnt/cephfs/newdir directory inherit the directory layout and places the data in the newly added erasure-coded pool. Additional Resources See The Ceph File System Metadata Server chapter in the Red Hat Ceph Storage File System Guide for more information about CephFS MDS. See the Creating Ceph File Systems section in the Red Hat Ceph Storage File System Guide for more information. See the Erasure Code Pools chapter in the Red Hat Ceph Storage Storage Strategies Guide for more information. See the Erasure Coding with Overwrites section in the Red Hat Ceph Storage Storage Strategies Guide for more information. 3.4. Creating client users for a Ceph File System Red Hat Ceph Storage uses cephx for authentication, which is enabled by default. To use cephx with the Ceph File System, create a user with the correct authorization capabilities on a Ceph Monitor node and make its key available on the node where the Ceph File System will be mounted. Prerequisites A running Red Hat Ceph Storage cluster. Installation and configuration of the Ceph Metadata Server daemon (ceph-mds). Root-level access to a Ceph Monitor node. Root-level access to a Ceph client node. Procedure Log into the Cephadm shell on the monitor node: Example On a Ceph Monitor node, create a client user: Syntax To restrict the client to only writing in the temp directory of filesystem cephfs_a : Example To completely restrict the client to the temp directory, remove the root ( / ) directory: Example Note Supplying all or asterisk as the file system name grants access to every file system. Typically, it is necessary to quote the asterisk to protect it from the shell. Verify the created key: Syntax Example Copy the keyring to the client. On the Ceph Monitor node, export the keyring to a file: Syntax Example Copy the client keyring from the Ceph Monitor node to the /etc/ceph/ directory on the client node: Syntax Replace CLIENT_NODE_NAME with the Ceph client node name or IP. Example From the client node, set the appropriate permissions for the keyring file: Syntax Example Additional Resources See the Ceph user management chapter in the Red Hat Ceph Storage Administration Guide for more details. 3.5. Mounting the Ceph File System as a kernel client You can mount the Ceph File System (CephFS) as a kernel client, either manually or automatically on system boot. Important Clients running on other Linux distributions, aside from Red Hat Enterprise Linux, are permitted but not supported. If issues are found in the CephFS Metadata Server or other parts of the storage cluster when using these clients, Red Hat will address them. If the cause is found to be on the client side, then the issue will have to be addressed by the kernel vendor of the Linux distribution. Prerequisites Root-level access to a Linux-based client node. Root-level access to a Ceph Monitor node. An existing Ceph File System. Procedure Configure the client node to use the Ceph storage cluster. Enable the Red Hat Ceph Storage 7 Tools repository: Red Hat Enterprise Linux 9 Install the ceph-common package: Log into the Cephadm shell on the monitor node: Example Copy the Ceph client keyring from the Ceph Monitor node to the client node: Syntax Replace CLIENT_NODE_NAME with the Ceph client host name or IP address. Example Copy the Ceph configuration file from a Ceph Monitor node to the client node: Syntax Replace CLIENT_NODE_NAME with the Ceph client host name or IP address. Example From the client node, set the appropriate permissions for the configuration file: Choose either automatically or manually mounting. Manually Mounting Create a mount directory on the client node: Syntax Example Mount the Ceph File System. To specify multiple Ceph Monitor addresses, separate them with commas in the mount command, specify the mount point, and set the client name: Note As of Red Hat Ceph Storage 4.1, mount.ceph can read keyring files directly. As such, a secret file is no longer necessary. Just specify the client ID with name= CLIENT_ID , and mount.ceph will find the right keyring file. Syntax Example Note You can configure a DNS server so that a single host name resolves to multiple IP addresses. Then you can use that single host name with the mount command, instead of supplying a comma-separated list. Note You can also replace the Monitor host names with the string :/ and mount.ceph will read the Ceph configuration file to determine which Monitors to connect to. Note You can set the nowsync option to asynchronously execute file creation and removal on the Red Hat Ceph Storage clusters. This improves the performance of some workloads by avoiding round-trip latency for these system calls without impacting consistency. The nowsync option requires kernel clients with Red Hat Enterprise Linux 9.0 or later. Example Verify that the file system is successfully mounted: Syntax Example Automatically Mounting On the client host, create a new directory for mounting the Ceph File System. Syntax Example Edit the /etc/fstab file as follows: Syntax The first column sets the Ceph Monitor host names and the port number. The second column sets the mount point The third column sets the file system type, in this case, ceph , for CephFS. The fourth column sets the various options, such as, the user name and the secret file using the name and secretfile options. You can also set specific volumes, sub-volume groups, and sub-volumes using the ceph.client_mountpoint option. Set the _netdev option to ensure that the file system is mounted after the networking subsystem starts to prevent hanging and networking issues. If you do not need access time information, then setting the noatime option can increase performance. Set the fifth and sixth columns to zero. Example The Ceph File System will be mounted on the system boot. Note As of Red Hat Ceph Storage 4.1, mount.ceph can read keyring files directly. As such, a secret file is no longer necessary. Just specify the client ID with name= CLIENT_ID , and mount.ceph will find the right keyring file. Note You can also replace the Monitor host names with the string :/ and mount.ceph will read the Ceph configuration file to determine which Monitors to connect to. Additional Resources See the mount(8) manual page. See the Ceph user management chapter in the Red Hat Ceph Storage Administration Guide for more details on creating a Ceph user. See the Creating Ceph File Systems section of the Red Hat Ceph Storage File System Guide for details. 3.6. Mounting the Ceph File System as a FUSE client You can mount the Ceph File System (CephFS) as a File System in User Space (FUSE) client, either manually or automatically on system boot. Prerequisites Root-level access to a Linux-based client node. Root-level access to a Ceph Monitor node. An existing Ceph File System. Procedure Configure the client node to use the Ceph storage cluster. Enable the Red Hat Ceph Storage 7 Tools repository: Red Hat Enterprise Linux 8 Red Hat Enterprise Linux 9 Install the ceph-fuse package: Log into the Cephadm shell on the monitor node: Example Copy the Ceph client keyring from the Ceph Monitor node to the client node: Syntax Replace CLIENT_NODE_NAME with the Ceph client host name or IP address. Example Copy the Ceph configuration file from a Ceph Monitor node to the client node: Syntax Replace CLIENT_NODE_NAME with the Ceph client host name or IP address. Example From the client node, set the appropriate permissions for the configuration file: Choose either automatically or manually mounting. Manually Mounting On the client node, create a directory for the mount point: Syntax Example Note If you used the path option with MDS capabilities, then the mount point must be within what is specified by the path . Use the ceph-fuse utility to mount the Ceph File System. Syntax Example Note If you do not use the default name and location of the user keyring, that is /etc/ceph/ceph.client. CLIENT_ID .keyring , then use the --keyring option to specify the path to the user keyring, for example: Example Note Use the -r option to instruct the client to treat that path as its root: Syntax Example Note If you want to automatically reconnect an evicted Ceph client, then add the --client_reconnect_stale=true option. Example Verify that the file system is successfully mounted: Syntax Example Automatically Mounting On the client node, create a directory for the mount point: Syntax Example Note If you used the path option with MDS capabilities, then the mount point must be within what is specified by the path . Edit the /etc/fstab file as follows: Syntax The first column sets the Ceph Monitor host names and the port number. The second column sets the mount point The third column sets the file system type, in this case, fuse.ceph , for CephFS. The fourth column sets the various options, such as the user name and the keyring using the ceph.name and ceph.keyring options. You can also set specific volumes, sub-volume groups, and sub-volumes using the ceph.client_mountpoint option. To specify which Ceph File System to access, use the ceph.client_fs option. Set the _netdev option to ensure that the file system is mounted after the networking subsystem starts to prevent hanging and networking issues. If you do not need access time information, then setting the noatime option can increase performance. If you want to automatically reconnect after an eviction, then set the client_reconnect_stale=true option. Set the fifth and sixth columns to zero. Example The Ceph File System will be mounted on the system boot. Additional Resources The ceph-fuse(8) manual page. See the Ceph user management chapter in the Red Hat Ceph Storage Administration Guide for more details on creating a Ceph user. See the Creating Ceph File Systems section of the Red Hat Ceph Storage File System Guide for details. Additional Resources See Section 2.5, "Management of MDS service using the Ceph Orchestrator" to install Ceph Metadata servers. See Section 3.2, "Creating Ceph File Systems" for details. See Section 3.4, "Creating client users for a Ceph File System" for details. See Section 3.5, "Mounting the Ceph File System as a kernel client" for details. See Section 3.6, "Mounting the Ceph File System as a FUSE client" for details. See Chapter 2, The Ceph File System Metadata Server for details on configuring the CephFS Metadata Server daemon.
[ "client.0 key: AQAz7EVWygILFRAAdIcuJ10opU/JKyfFmxhuaw== caps: [mds] allow rwp caps: [mon] allow r caps: [osd] allow rw tag cephfs data=cephfs_a client.1 key: AQAz7EVWygILFRAAdIcuJ11opU/JKyfFmxhuaw== caps: [mds] allow rw caps: [mon] allow r caps: [osd] allow rw tag cephfs data=cephfs_a", "client.0 key: AQAz7EVWygILFRAAdIcuJ10opU/JKyfFmxhuaw== caps: [mds] allow rw, allow rws path=/temp caps: [mon] allow r caps: [osd] allow rw tag cephfs data=cephfs_a", "client.0 key: AQAz7EVWygILFRAAdIcuJ10opU/JKyfFmxhuaw== caps: [mds] allow r network 10.0.0.0/8, allow rw path=/bar network 10.0.0.0/8 caps: [mon] allow r network 10.0.0.0/8 caps: [osd] allow rw tag cephfs data=cephfs_a network 10.0.0.0/8", "subscription-manager repos --enable=rhceph-6-tools-for-rhel-8-x86_64-rpms", "subscription-manager repos --enable=rhceph-6-tools-for-rhel-9-x86_64-rpms", "dnf install ceph-fuse", "scp root@ MONITOR_NODE_NAME :/etc/ceph/ KEYRING_FILE /etc/ceph/", "scp [email protected]:/etc/ceph/ceph.client.1.keyring /etc/ceph/", "scp root@ MONITOR_NODE_NAME :/etc/ceph/ceph.conf /etc/ceph/ceph.conf", "scp [email protected]:/etc/ceph/ceph.conf /etc/ceph/ceph.conf", "chmod 644 /etc/ceph/ceph.conf", "ceph fs volume create FILE_SYSTEM_NAME", "ceph fs volume create cephfs01", "ceph fs authorize FILE_SYSTEM_NAME CLIENT_NAME DIRECTORY PERMISSIONS", "ceph fs authorize cephfs01 client.1 / rw [client.1] key = BQAmthpf81M+JhAAiHDYQkMiCq3x+J0n9e8REK== ceph auth get client.1 exported keyring for client.1 [client.1] key = BQAmthpf81M+JhAAiHDYQkMiCq3x+J0n9e8REK== caps mds = \"allow rw fsname=cephfs01\" caps mon = \"allow r fsname=cephfs01\" caps osd = \"allow rw tag cephfs data=cephfs01\"", "ceph fs authorize cephfs01 client.1 / rw root_squash /volumes rw [client.1] key = BQAmthpf81M+JhAAiHDYQkMiCq3x+J0n9e8REK== ceph auth get client.1 [client.1] key = BQAmthpf81M+JhAAiHDYQkMiCq3x+J0n9e8REK== caps mds = \"allow rw fsname=cephfs01 root_squash, allow rw fsname=cephfs01 path=/volumes\" caps mon = \"allow r fsname=cephfs01\" caps osd = \"allow rw tag cephfs data=cephfs01\"", "ceph auth get CLIENT_NAME > OUTPUT_FILE_NAME scp OUTPUT_FILE_NAME TARGET_NODE_NAME :/etc/ceph", "ceph auth get client.1 > ceph.client.1.keyring exported keyring for client.1 scp ceph.client.1.keyring client:/etc/ceph root@client's password: ceph.client.1.keyring 100% 178 333.0KB/s 00:00", "mkdir PATH_TO_NEW_DIRECTORY_NAME", "mkdir /mnt/mycephfs", "ceph-fuse PATH_TO_NEW_DIRECTORY_NAME -n CEPH_USER_NAME --client-fs=_FILE_SYSTEM_NAME", "ceph-fuse /mnt/mycephfs/ -n client.1 --client-fs=cephfs01 ceph-fuse[555001]: starting ceph client 2022-05-09T07:33:27.158+0000 7f11feb81200 -1 init, newargv = 0x55fc4269d5d0 newargc=15 ceph-fuse[555001]: starting fuse", "ceph osd pool create DATA_POOL_NAME erasure", "ceph osd pool create cephfs-data-ec01 erasure pool 'cephfs-data-ec01' created", "ceph osd lspools", "ceph osd pool set DATA_POOL_NAME allow_ec_overwrites true", "ceph osd pool set cephfs-data-ec01 allow_ec_overwrites true set pool 15 allow_ec_overwrites to true", "ceph fs status FILE_SYSTEM_NAME", "ceph fs status cephfs-ec cephfs-ec - 14 clients ========= RANK STATE MDS ACTIVITY DNS INOS DIRS CAPS 0 active cephfs-ec.example.ooymyq Reqs: 0 /s 8231 8233 891 921 POOL TYPE USED AVAIL cephfs-metadata-ec metadata 787M 8274G cephfs-data-ec data 2360G 12.1T STANDBY MDS cephfs-ec.example.irsrql cephfs-ec.example.cauuaj", "ceph fs add_data_pool FILE_SYSTEM_NAME DATA_POOL_NAME", "ceph fs add_data_pool cephfs-ec cephfs-data-ec01", "ceph fs status FILE_SYSTEM_NAME", "ceph fs status cephfs-ec cephfs-ec - 14 clients ========= RANK STATE MDS ACTIVITY DNS INOS DIRS CAPS 0 active cephfs-ec.example.ooymyq Reqs: 0 /s 8231 8233 891 921 POOL TYPE USED AVAIL cephfs-metadata-ec metadata 787M 8274G cephfs-data-ec data 2360G 12.1T cephfs-data-ec01 data 0 12.1T STANDBY MDS cephfs-ec.example.irsrql cephfs-ec.example.cauuaj", "mkdir PATH_TO_DIRECTORY setfattr -n ceph.dir.layout.pool -v DATA_POOL_NAME PATH_TO_DIRECTORY", "mkdir /mnt/cephfs/newdir setfattr -n ceph.dir.layout.pool -v cephfs-data-ec01 /mnt/cephfs/newdir", "cephadm shell", "ceph fs authorize FILE_SYSTEM_NAME client. CLIENT_NAME / DIRECTORY CAPABILITY [/ DIRECTORY CAPABILITY ] PERMISSIONS", "ceph fs authorize cephfs_a client.1 / r /temp rw client.1 key = AQBSdFhcGZFUDRAAcKhG9Cl2HPiDMMRv4DC43A==", "ceph fs authorize cephfs_a client.1 /temp rw", "ceph auth get client. ID", "ceph auth get client.1 client.1 key = AQBSdFhcGZFUDRAAcKhG9Cl2HPiDMMRv4DC43A== caps mds = \"allow r, allow rw path=/temp\" caps mon = \"allow r\" caps osd = \"allow rw tag cephfs data=cephfs_a\"", "ceph auth get client. ID -o ceph.client. ID .keyring", "ceph auth get client.1 -o ceph.client.1.keyring exported keyring for client.1", "scp /ceph.client. ID .keyring root@ CLIENT_NODE_NAME :/etc/ceph/ceph.client. ID .keyring", "scp /ceph.client.1.keyring root@client01:/etc/ceph/ceph.client.1.keyring", "chmod 644 ceph.client. ID .keyring", "chmod 644 /etc/ceph/ceph.client.1.keyring", "subscription-manager repos --enable=rhceph-6-tools-for-rhel-9-x86_64-rpms", "dnf install ceph-common", "cephadm shell", "scp /ceph.client. ID .keyring root@ CLIENT_NODE_NAME :/etc/ceph/ceph.client. ID .keyring", "scp /ceph.client.1.keyring root@client01:/etc/ceph/ceph.client.1.keyring", "scp /etc/ceph/ceph.conf root@ CLIENT_NODE_NAME :/etc/ceph/ceph.conf", "scp /etc/ceph/ceph.conf root@client01:/etc/ceph/ceph.conf", "chmod 644 /etc/ceph/ceph.conf", "mkdir -p MOUNT_POINT", "mkdir -p /mnt/cephfs", "mount -t ceph MONITOR-1_NAME :6789, MONITOR-2_NAME :6789, MONITOR-3_NAME :6789:/ MOUNT_POINT -o name= CLIENT_ID ,fs= FILE_SYSTEM_NAME", "mount -t ceph mon1:6789,mon2:6789,mon3:6789:/ /mnt/cephfs -o name=1,fs=cephfs01", "mount -t ceph mon1:6789,mon2:6789,mon3:6789:/ /mnt/cephfs -o nowsync,name=1,fs=cephfs01", "stat -f MOUNT_POINT", "stat -f /mnt/cephfs", "mkdir -p MOUNT_POINT", "mkdir -p /mnt/cephfs", "#DEVICE PATH TYPE OPTIONS MON_0_HOST : PORT , MOUNT_POINT ceph name= CLIENT_ID , MON_1_HOST : PORT , ceph.client_mountpoint=/ VOL / SUB_VOL_GROUP / SUB_VOL / UID_SUB_VOL , fs= FILE_SYSTEM_NAME , MON_2_HOST : PORT :/q[_VOL_]/ SUB_VOL / UID_SUB_VOL , [ ADDITIONAL_OPTIONS ]", "#DEVICE PATH TYPE OPTIONS DUMP FSCK mon1:6789, /mnt/cephfs ceph name=1, 0 0 mon2:6789, ceph.client_mountpoint=/my_vol/my_sub_vol_group/my_sub_vol/0, mon3:6789:/ fs=cephfs01, _netdev,noatime", "subscription-manager repos --enable=6-tools-for-rhel-8-x86_64-rpms", "subscription-manager repos --enable=6-tools-for-rhel-9-x86_64-rpms", "dnf install ceph-fuse", "cephadm shell", "scp /ceph.client. ID .keyring root@ CLIENT_NODE_NAME :/etc/ceph/ceph.client. ID .keyring", "scp /ceph.client.1.keyring root@client01:/etc/ceph/ceph.client.1.keyring", "scp /etc/ceph/ceph.conf root@ CLIENT_NODE_NAME :/etc/ceph/ceph.conf", "scp /etc/ceph/ceph.conf root@client01:/etc/ceph/ceph.conf", "chmod 644 /etc/ceph/ceph.conf", "mkdir PATH_TO_MOUNT_POINT", "mkdir /mnt/mycephfs", "ceph-fuse -n client. CLIENT_ID --client_fs FILE_SYSTEM_NAME MOUNT_POINT", "ceph-fuse -n client.1 --client_fs cephfs01 /mnt/mycephfs", "ceph-fuse -n client.1 --keyring=/etc/ceph/client.1.keyring /mnt/mycephfs", "ceph-fuse -n client. CLIENT_ID MOUNT_POINT -r PATH", "ceph-fuse -n client.1 /mnt/cephfs -r /home/cephfs", "ceph-fuse -n client.1 /mnt/cephfs --client_reconnect_stale=true", "stat -f MOUNT_POINT", "stat -f /mnt/cephfs", "mkdir PATH_TO_MOUNT_POINT", "mkdir /mnt/mycephfs", "#DEVICE PATH TYPE OPTIONS DUMP FSCK HOST_NAME : PORT , MOUNT_POINT fuse.ceph ceph.id= CLIENT_ID , 0 0 HOST_NAME : PORT , ceph.client_mountpoint=/ VOL / SUB_VOL_GROUP / SUB_VOL / UID_SUB_VOL , HOST_NAME : PORT :/ ceph.client_fs= FILE_SYSTEM_NAME ,ceph.name= USERNAME ,ceph.keyring=/etc/ceph/ KEYRING_FILE , [ ADDITIONAL_OPTIONS ]", "#DEVICE PATH TYPE OPTIONS DUMP FSCK mon1:6789, /mnt/mycephfs fuse.ceph ceph.id=1, 0 0 mon2:6789, ceph.client_mountpoint=/my_vol/my_sub_vol_group/my_sub_vol/0, mon3:6789:/ ceph.client_fs=cephfs01,ceph.name=client.1,ceph.keyring=/etc/ceph/client1.keyring, _netdev,defaults" ]
https://docs.redhat.com/en/documentation/red_hat_ceph_storage/7/html/file_system_guide/deployment-of-the-ceph-file-system
Appendix D. Enabling FIPS in Red Hat Virtualization
Appendix D. Enabling FIPS in Red Hat Virtualization You can set up Red Hat Virtualization to be compliant with the Federal Information Processing Standard (FIPS), specifically FIPS 140-2. You can enable FIPS mode selectively, on specific virtual machines, bare metal machines, or across your entire environment, based on your organization's FIPS compliance requirements. You can create a FIPS-enabled bare metal machine in RHV 4.4 by either installing the operating system in FIPS mode, or by switching the system into FIPS mode after installing the operating system. However, you must switch to FIPS mode before installing and configuring Red Hat Virtualization to avoid introducing system conflicts. Important Red Hat recommends installing RHEL 8 with FIPS mode enabled as opposed to enabling FIPS mode later. Enabling FIPS mode during the installation ensures that the system generates all keys with FIPS-approved algorithms and continuous monitoring tests in place. You enable FIPS first on each bare metal machine, and then in the Manager. Enabling FIPS in a self-hosted engine Enabling FIPS in RHEL hosts and the standalone Manager D.1. Enabling FIPS in a self-hosted engine You can enable FIPS in a self-hosted engine during deployment when using the command-line. Procedure Start the self-hosted engine deployment script. See Installing Red Hat Virtualization as a self-hosted engine using the command line . When the deployment script prompts Do you want to enable FIPS? , enter Yes Verification Verify that FIPS is enabled by entering the command fips-mode-setup --check on the host. The command should return FIPS mode is enabled : # fips-mode-setup --check FIPS mode is enabled.
[ "fips-mode-setup --check FIPS mode is enabled." ]
https://docs.redhat.com/en/documentation/red_hat_virtualization/4.4/html/administration_guide/enabling-fips_in_rhv
Chapter 59. Security
Chapter 59. Security scap-security-guide example kickstart files for Red Hat Enterprise Linux 6 are not recommended for use The Red Hat Enterprise Linux 6 example kickstart files, which are included in the scap-security-guide package for Red Hat Enterprise Linux 7, install the latest version of the scap-security-guide package directly from the upstream repository, which means that this version has not been checked by the Red Hat Quality Engineering team. To work around this problem, use the corrected Red Hat Enterprise Linux 6 example kickstart files from the scap-security-guide package that is included in the current Red Hat Enterprise Linux 6 release, or alternatively, manually change the %post section in the kickstart file. Note that the Red Hat Enterprise Linux 7 example kickstart files are not affected by this problem. (BZ# 1378489 ) The openscap packages do not install atomic as a dependency The OpenSCAP suite enables integration of the Security Content Automation Protocol (SCAP) line of standards. The current version adds the ability to scan containers using the atomic scan and oscap-docker commands. However, when you install only the openscap , openscap-utils , and openscap-scanner packages, the atomic package is not installed by default. As a consequence, any container scan command fails with an error message. To work around this problem, install the atomic package by running the yum install atomic command as root. (BZ#1356547) CIL does not have a separate module statement The new SELinux userspace uses SELinux Common Intermediate Language (CIL) in the module store. CIL treats files as modules and does not have a separate module statement, the module is named after the file name. As a consequence, this can cause confusion when a policy module has a name that is not the same as its base filename, and the semodule -l command does not show the module version. Additionaly, semodule -l does not show disabled modules. To work around this problem, list all modules using the semodule --l=full command. (BZ#1345825)
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/7.3_release_notes/known_issues_security
Installing on IBM Z and IBM LinuxONE
Installing on IBM Z and IBM LinuxONE OpenShift Container Platform 4.13 Installing OpenShift Container Platform on IBM Z and IBM LinuxONE Red Hat OpenShift Documentation Team
[ "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. IN MX 10 smtp.example.com. ; ; ns1.example.com. IN A 192.168.1.5 smtp.example.com. IN A 192.168.1.5 ; helper.example.com. IN A 192.168.1.5 helper.ocp4.example.com. IN A 192.168.1.5 ; api.ocp4.example.com. IN A 192.168.1.5 1 api-int.ocp4.example.com. IN A 192.168.1.5 2 ; *.apps.ocp4.example.com. IN A 192.168.1.5 3 ; bootstrap.ocp4.example.com. IN A 192.168.1.96 4 ; control-plane0.ocp4.example.com. IN A 192.168.1.97 5 control-plane1.ocp4.example.com. IN A 192.168.1.98 6 control-plane2.ocp4.example.com. IN A 192.168.1.99 7 ; compute0.ocp4.example.com. IN A 192.168.1.11 8 compute1.ocp4.example.com. IN A 192.168.1.7 9 ; ;EOF", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. ; 5.1.168.192.in-addr.arpa. IN PTR api.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. IN PTR api-int.ocp4.example.com. 2 ; 96.1.168.192.in-addr.arpa. IN PTR bootstrap.ocp4.example.com. 3 ; 97.1.168.192.in-addr.arpa. IN PTR control-plane0.ocp4.example.com. 4 98.1.168.192.in-addr.arpa. IN PTR control-plane1.ocp4.example.com. 5 99.1.168.192.in-addr.arpa. IN PTR control-plane2.ocp4.example.com. 6 ; 11.1.168.192.in-addr.arpa. IN PTR compute0.ocp4.example.com. 7 7.1.168.192.in-addr.arpa. IN PTR compute1.ocp4.example.com. 8 ; ;EOF", "global log 127.0.0.1 local2 pidfile /var/run/haproxy.pid maxconn 4000 daemon defaults mode http log global option dontlognull option http-server-close option redispatch retries 3 timeout http-request 10s timeout queue 1m timeout connect 10s timeout client 1m timeout server 1m timeout http-keep-alive 10s timeout check 10s maxconn 3000 listen api-server-6443 1 bind *:6443 mode tcp option httpchk GET /readyz HTTP/1.0 option log-health-checks balance roundrobin server bootstrap bootstrap.ocp4.example.com:6443 verify none check check-ssl inter 10s fall 2 rise 3 backup 2 server master0 master0.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master1 master1.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master2 master2.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 listen machine-config-server-22623 3 bind *:22623 mode tcp server bootstrap bootstrap.ocp4.example.com:22623 check inter 1s backup 4 server master0 master0.ocp4.example.com:22623 check inter 1s server master1 master1.ocp4.example.com:22623 check inter 1s server master2 master2.ocp4.example.com:22623 check inter 1s listen ingress-router-443 5 bind *:443 mode tcp balance source server worker0 worker0.ocp4.example.com:443 check inter 1s server worker1 worker1.ocp4.example.com:443 check inter 1s listen ingress-router-80 6 bind *:80 mode tcp balance source server worker0 worker0.ocp4.example.com:80 check inter 1s server worker1 worker1.ocp4.example.com:80 check inter 1s", "dig +noall +answer @<nameserver_ip> api.<cluster_name>.<base_domain> 1", "api.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> api-int.<cluster_name>.<base_domain>", "api-int.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> random.apps.<cluster_name>.<base_domain>", "random.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> console-openshift-console.apps.<cluster_name>.<base_domain>", "console-openshift-console.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> bootstrap.<cluster_name>.<base_domain>", "bootstrap.ocp4.example.com. 604800 IN A 192.168.1.96", "dig +noall +answer @<nameserver_ip> -x 192.168.1.5", "5.1.168.192.in-addr.arpa. 604800 IN PTR api-int.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. 604800 IN PTR api.ocp4.example.com. 2", "dig +noall +answer @<nameserver_ip> -x 192.168.1.96", "96.1.168.192.in-addr.arpa. 604800 IN PTR bootstrap.ocp4.example.com.", "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "tar -xvf openshift-install-linux.tar.gz", "tar xvf <file>", "echo USDPATH", "oc <command>", "C:\\> path", "C:\\> oc <command>", "echo USDPATH", "oc <command>", "mkdir <installation_directory>", "apiVersion: v1 baseDomain: example.com 1 compute: 2 - hyperthreading: Enabled 3 name: worker replicas: 0 4 architecture: s390x controlPlane: 5 hyperthreading: Enabled 6 name: master replicas: 3 7 architecture: s390x metadata: name: test 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 10 networkType: OVNKubernetes 11 serviceNetwork: 12 - 172.30.0.0/16 platform: none: {} 13 fips: false 14 pullSecret: '{\"auths\": ...}' 15 sshKey: 'ssh-ed25519 AAAA...' 16", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "compute: - name: worker platform: {} replicas: 0", "spec: clusterNetwork: - cidr: 10.128.0.0/19 hostPrefix: 23 - cidr: 10.128.32.0/19 hostPrefix: 23", "spec: serviceNetwork: - 172.30.0.0/14", "defaultNetwork: type: OpenShiftSDN openshiftSDNConfig: mode: NetworkPolicy mtu: 1450 vxlanPort: 4789", "defaultNetwork: type: OVNKubernetes ovnKubernetesConfig: mtu: 1400 genevePort: 6081 ipsecConfig: {}", "kubeProxyConfig: proxyArguments: iptables-min-sync-period: - 0s", "./openshift-install create manifests --dir <installation_directory> 1", "./openshift-install create ignition-configs --dir <installation_directory> 1", ". ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign", "variant: openshift version: 4.13.0 metadata: name: master-storage labels: machineconfiguration.openshift.io/role: master storage: luks: - clevis: tang: - thumbprint: QcPr_NHFJammnRCA3fFMVdNBwjs url: http://clevis.example.com:7500 options: 1 - --cipher - aes-cbc-essiv:sha256 device: /dev/disk/by-partlabel/root 2 label: luks-root name: root wipe_volume: true filesystems: - device: /dev/mapper/root format: xfs label: root wipe_filesystem: true openshift: fips: true 3", "coreos-installer pxe customize /root/rhcos-bootfiles/rhcos-<release>-live-initramfs.s390x.img --dest-device /dev/disk/by-id/scsi-<serial-number> --dest-karg-append ip=<ip-address>::<gateway-ip>:<subnet-mask>::<network-device>:none --dest-karg-append nameserver=<nameserver-ip> --dest-karg-append rd.neednet=1 -o /root/rhcos-bootfiles/<Node-name>-initramfs.s390x.img", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/dasda \\ 1 ignition.firstboot ignition.platform.id=metal coreos.live.rootfs_url=http://10.19.17.25/redhat/ocp/rhcos-413.86.202302201445-0/rhcos-413.86.202302201445-0-live-rootfs.s390x.img coreos.inst.ignition_url=http://bastion.ocp-cluster1.example.com:8080/ignition/master.ign ip=10.19.17.2::10.19.17.1:255.255.255.0::enbdd0:none nameserver=10.19.17.1 zfcp.allow_lun_scan=0 \\ 2 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000 \\ 3 zfcp.allow_lun_scan=0 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/dasda coreos.live.rootfs_url=http://cl1.provide.example.com:8080/assets/rhcos-live-rootfs.s390x.img coreos.inst.ignition_url=http://cl1.provide.example.com:8080/ignition/bootstrap.ign ip=172.18.78.2::172.18.78.1:255.255.255.0:::none nameserver=172.18.78.1 rd.znet=qeth,0.0.bdf0,0.0.bdf1,0.0.bdf2,layer2=1,portno=0 zfcp.allow_lun_scan=0 rd.dasd=0.0.3490", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/disk/by-id/scsi-<serial_number> coreos.live.rootfs_url=http://cl1.provide.example.com:8080/assets/rhcos-live-rootfs.s390x.img coreos.inst.ignition_url=http://cl1.provide.example.com:8080/ignition/worker.ign ip=172.18.78.2::172.18.78.1:255.255.255.0:::none nameserver=172.18.78.1 rd.znet=qeth,0.0.bdf0,0.0.bdf1,0.0.bdf2,layer2=1,portno=0 zfcp.allow_lun_scan=0 rd.zfcp=0.0.1987,0x50050763070bc5e3,0x4008400B00000000 rd.zfcp=0.0.19C7,0x50050763070bc5e3,0x4008400B00000000 rd.zfcp=0.0.1987,0x50050763071bc5e3,0x4008400B00000000 rd.zfcp=0.0.19C7,0x50050763071bc5e3,0x4008400B00000000", "ipl c", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0::enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=10.10.10.3::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=::10.10.10.254::::", "rd.route=20.20.20.0/24:20.20.20.254:enp2s0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=::::core0.example.com:enp2s0:none", "ip=enp1s0:dhcp ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0.100:none vlan=enp2s0.100:enp2s0", "ip=enp2s0.100:dhcp vlan=enp2s0.100:enp2s0", "nameserver=1.1.1.1 nameserver=8.8.8.8", "bond=bond0:em1,em2:mode=active-backup ip=bond0:dhcp", "bond=bond0:em1,em2:mode=active-backup,fail_over_mac=1 ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:bond0:none", "ip=bond0.100:dhcp bond=bond0:em1,em2:mode=active-backup vlan=bond0.100:bond0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:bond0.100:none bond=bond0:em1,em2:mode=active-backup vlan=bond0.100:bond0", "team=team0:em1,em2 ip=team0:dhcp", "./openshift-install --dir <installation_directory> wait-for bootstrap-complete \\ 1 --log-level=info 2", "INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443 INFO API v1.26.0 up INFO Waiting up to 30m0s for bootstrapping to complete INFO It is now safe to remove the bootstrap resources", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-mddf5 20m system:node:master-01.example.com Approved,Issued csr-z5rln 16m system:node:worker-21.example.com Approved,Issued", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs oc adm certificate approve", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "oc get pod -n openshift-image-registry -l docker-registry=default", "No resources found in openshift-image-registry namespace", "oc edit configs.imageregistry.operator.openshift.io", "storage: pvc: claim:", "oc get clusteroperator image-registry", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE image-registry 4.13 True False False 6h50m", "oc edit configs.imageregistry/cluster", "managementState: Removed", "managementState: Managed", "oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{\"spec\":{\"storage\":{\"emptyDir\":{}}}}'", "Error from server (NotFound): configs.imageregistry.operator.openshift.io \"cluster\" not found", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "./openshift-install --dir <installation_directory> wait-for install-complete 1", "INFO Waiting up to 30m0s for the cluster to initialize", "oc get pods --all-namespaces", "NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m", "oc logs <pod_name> -n <namespace> 1", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. IN MX 10 smtp.example.com. ; ; ns1.example.com. IN A 192.168.1.5 smtp.example.com. IN A 192.168.1.5 ; helper.example.com. IN A 192.168.1.5 helper.ocp4.example.com. IN A 192.168.1.5 ; api.ocp4.example.com. IN A 192.168.1.5 1 api-int.ocp4.example.com. IN A 192.168.1.5 2 ; *.apps.ocp4.example.com. IN A 192.168.1.5 3 ; bootstrap.ocp4.example.com. IN A 192.168.1.96 4 ; control-plane0.ocp4.example.com. IN A 192.168.1.97 5 control-plane1.ocp4.example.com. IN A 192.168.1.98 6 control-plane2.ocp4.example.com. IN A 192.168.1.99 7 ; compute0.ocp4.example.com. IN A 192.168.1.11 8 compute1.ocp4.example.com. IN A 192.168.1.7 9 ; ;EOF", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. ; 5.1.168.192.in-addr.arpa. IN PTR api.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. IN PTR api-int.ocp4.example.com. 2 ; 96.1.168.192.in-addr.arpa. IN PTR bootstrap.ocp4.example.com. 3 ; 97.1.168.192.in-addr.arpa. IN PTR control-plane0.ocp4.example.com. 4 98.1.168.192.in-addr.arpa. IN PTR control-plane1.ocp4.example.com. 5 99.1.168.192.in-addr.arpa. IN PTR control-plane2.ocp4.example.com. 6 ; 11.1.168.192.in-addr.arpa. IN PTR compute0.ocp4.example.com. 7 7.1.168.192.in-addr.arpa. IN PTR compute1.ocp4.example.com. 8 ; ;EOF", "global log 127.0.0.1 local2 pidfile /var/run/haproxy.pid maxconn 4000 daemon defaults mode http log global option dontlognull option http-server-close option redispatch retries 3 timeout http-request 10s timeout queue 1m timeout connect 10s timeout client 1m timeout server 1m timeout http-keep-alive 10s timeout check 10s maxconn 3000 listen api-server-6443 1 bind *:6443 mode tcp option httpchk GET /readyz HTTP/1.0 option log-health-checks balance roundrobin server bootstrap bootstrap.ocp4.example.com:6443 verify none check check-ssl inter 10s fall 2 rise 3 backup 2 server master0 master0.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master1 master1.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master2 master2.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 listen machine-config-server-22623 3 bind *:22623 mode tcp server bootstrap bootstrap.ocp4.example.com:22623 check inter 1s backup 4 server master0 master0.ocp4.example.com:22623 check inter 1s server master1 master1.ocp4.example.com:22623 check inter 1s server master2 master2.ocp4.example.com:22623 check inter 1s listen ingress-router-443 5 bind *:443 mode tcp balance source server worker0 worker0.ocp4.example.com:443 check inter 1s server worker1 worker1.ocp4.example.com:443 check inter 1s listen ingress-router-80 6 bind *:80 mode tcp balance source server worker0 worker0.ocp4.example.com:80 check inter 1s server worker1 worker1.ocp4.example.com:80 check inter 1s", "dig +noall +answer @<nameserver_ip> api.<cluster_name>.<base_domain> 1", "api.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> api-int.<cluster_name>.<base_domain>", "api-int.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> random.apps.<cluster_name>.<base_domain>", "random.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> console-openshift-console.apps.<cluster_name>.<base_domain>", "console-openshift-console.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> bootstrap.<cluster_name>.<base_domain>", "bootstrap.ocp4.example.com. 604800 IN A 192.168.1.96", "dig +noall +answer @<nameserver_ip> -x 192.168.1.5", "5.1.168.192.in-addr.arpa. 604800 IN PTR api-int.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. 604800 IN PTR api.ocp4.example.com. 2", "dig +noall +answer @<nameserver_ip> -x 192.168.1.96", "96.1.168.192.in-addr.arpa. 604800 IN PTR bootstrap.ocp4.example.com.", "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "mkdir <installation_directory>", "apiVersion: v1 baseDomain: example.com 1 compute: 2 - hyperthreading: Enabled 3 name: worker replicas: 0 4 architecture: s390x controlPlane: 5 hyperthreading: Enabled 6 name: master replicas: 3 7 architecture: s390x metadata: name: test 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 10 networkType: OVNKubernetes 11 serviceNetwork: 12 - 172.30.0.0/16 platform: none: {} 13 fips: false 14 pullSecret: '{\"auths\":{\"<local_registry>\": {\"auth\": \"<credentials>\",\"email\": \"[email protected]\"}}}' 15 sshKey: 'ssh-ed25519 AAAA...' 16 additionalTrustBundle: | 17 -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- imageContentSources: 18 - mirrors: - <local_repository>/ocp4/openshift4 source: quay.io/openshift-release-dev/ocp-release - mirrors: - <local_repository>/ocp4/openshift4 source: quay.io/openshift-release-dev/ocp-v4.0-art-dev", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "compute: - name: worker platform: {} replicas: 0", "spec: clusterNetwork: - cidr: 10.128.0.0/19 hostPrefix: 23 - cidr: 10.128.32.0/19 hostPrefix: 23", "spec: serviceNetwork: - 172.30.0.0/14", "defaultNetwork: type: OpenShiftSDN openshiftSDNConfig: mode: NetworkPolicy mtu: 1450 vxlanPort: 4789", "defaultNetwork: type: OVNKubernetes ovnKubernetesConfig: mtu: 1400 genevePort: 6081 ipsecConfig: {}", "kubeProxyConfig: proxyArguments: iptables-min-sync-period: - 0s", "./openshift-install create manifests --dir <installation_directory> 1", "./openshift-install create ignition-configs --dir <installation_directory> 1", ". ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign", "variant: openshift version: 4.13.0 metadata: name: master-storage labels: machineconfiguration.openshift.io/role: master storage: luks: - clevis: tang: - thumbprint: QcPr_NHFJammnRCA3fFMVdNBwjs url: http://clevis.example.com:7500 options: 1 - --cipher - aes-cbc-essiv:sha256 device: /dev/disk/by-partlabel/root 2 label: luks-root name: root wipe_volume: true filesystems: - device: /dev/mapper/root format: xfs label: root wipe_filesystem: true openshift: fips: true 3", "coreos-installer pxe customize /root/rhcos-bootfiles/rhcos-<release>-live-initramfs.s390x.img --dest-device /dev/disk/by-id/scsi-<serial-number> --dest-karg-append ip=<ip-address>::<gateway-ip>:<subnet-mask>::<network-device>:none --dest-karg-append nameserver=<nameserver-ip> --dest-karg-append rd.neednet=1 -o /root/rhcos-bootfiles/<Node-name>-initramfs.s390x.img", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/dasda \\ 1 ignition.firstboot ignition.platform.id=metal coreos.live.rootfs_url=http://10.19.17.25/redhat/ocp/rhcos-413.86.202302201445-0/rhcos-413.86.202302201445-0-live-rootfs.s390x.img coreos.inst.ignition_url=http://bastion.ocp-cluster1.example.com:8080/ignition/master.ign ip=10.19.17.2::10.19.17.1:255.255.255.0::enbdd0:none nameserver=10.19.17.1 zfcp.allow_lun_scan=0 \\ 2 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000 \\ 3 zfcp.allow_lun_scan=0 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/dasda coreos.live.rootfs_url=http://cl1.provide.example.com:8080/assets/rhcos-live-rootfs.s390x.img coreos.inst.ignition_url=http://cl1.provide.example.com:8080/ignition/bootstrap.ign ip=172.18.78.2::172.18.78.1:255.255.255.0:::none nameserver=172.18.78.1 rd.znet=qeth,0.0.bdf0,0.0.bdf1,0.0.bdf2,layer2=1,portno=0 zfcp.allow_lun_scan=0 rd.dasd=0.0.3490", "rd.neednet=1 console=ttysclp0 coreos.inst.install_dev=/dev/disk/by-id/scsi-<serial_number> coreos.live.rootfs_url=http://cl1.provide.example.com:8080/assets/rhcos-live-rootfs.s390x.img coreos.inst.ignition_url=http://cl1.provide.example.com:8080/ignition/worker.ign ip=172.18.78.2::172.18.78.1:255.255.255.0:::none nameserver=172.18.78.1 rd.znet=qeth,0.0.bdf0,0.0.bdf1,0.0.bdf2,layer2=1,portno=0 zfcp.allow_lun_scan=0 rd.zfcp=0.0.1987,0x50050763070bc5e3,0x4008400B00000000 rd.zfcp=0.0.19C7,0x50050763070bc5e3,0x4008400B00000000 rd.zfcp=0.0.1987,0x50050763071bc5e3,0x4008400B00000000 rd.zfcp=0.0.19C7,0x50050763071bc5e3,0x4008400B00000000", "ipl c", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0::enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=10.10.10.3::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=::10.10.10.254::::", "rd.route=20.20.20.0/24:20.20.20.254:enp2s0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=::::core0.example.com:enp2s0:none", "ip=enp1s0:dhcp ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0.100:none vlan=enp2s0.100:enp2s0", "ip=enp2s0.100:dhcp vlan=enp2s0.100:enp2s0", "nameserver=1.1.1.1 nameserver=8.8.8.8", "bond=bond0:em1,em2:mode=active-backup ip=bond0:dhcp", "bond=bond0:em1,em2:mode=active-backup,fail_over_mac=1 ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:bond0:none", "ip=bond0.100:dhcp bond=bond0:em1,em2:mode=active-backup vlan=bond0.100:bond0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:bond0.100:none bond=bond0:em1,em2:mode=active-backup vlan=bond0.100:bond0", "team=team0:em1,em2 ip=team0:dhcp", "./openshift-install --dir <installation_directory> wait-for bootstrap-complete \\ 1 --log-level=info 2", "INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443 INFO API v1.26.0 up INFO Waiting up to 30m0s for bootstrapping to complete INFO It is now safe to remove the bootstrap resources", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs oc adm certificate approve", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "oc patch OperatorHub cluster --type json -p '[{\"op\": \"add\", \"path\": \"/spec/disableAllDefaultSources\", \"value\": true}]'", "oc get pod -n openshift-image-registry -l docker-registry=default", "No resources found in openshift-image-registry namespace", "oc edit configs.imageregistry.operator.openshift.io", "storage: pvc: claim:", "oc get clusteroperator image-registry", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE image-registry 4.13 True False False 6h50m", "oc edit configs.imageregistry/cluster", "managementState: Removed", "managementState: Managed", "oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{\"spec\":{\"storage\":{\"emptyDir\":{}}}}'", "Error from server (NotFound): configs.imageregistry.operator.openshift.io \"cluster\" not found", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "./openshift-install --dir <installation_directory> wait-for install-complete 1", "INFO Waiting up to 30m0s for the cluster to initialize", "oc get pods --all-namespaces", "NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m", "oc logs <pod_name> -n <namespace> 1", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. IN MX 10 smtp.example.com. ; ; ns1.example.com. IN A 192.168.1.5 smtp.example.com. IN A 192.168.1.5 ; helper.example.com. IN A 192.168.1.5 helper.ocp4.example.com. IN A 192.168.1.5 ; api.ocp4.example.com. IN A 192.168.1.5 1 api-int.ocp4.example.com. IN A 192.168.1.5 2 ; *.apps.ocp4.example.com. IN A 192.168.1.5 3 ; bootstrap.ocp4.example.com. IN A 192.168.1.96 4 ; control-plane0.ocp4.example.com. IN A 192.168.1.97 5 control-plane1.ocp4.example.com. IN A 192.168.1.98 6 control-plane2.ocp4.example.com. IN A 192.168.1.99 7 ; compute0.ocp4.example.com. IN A 192.168.1.11 8 compute1.ocp4.example.com. IN A 192.168.1.7 9 ; ;EOF", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. ; 5.1.168.192.in-addr.arpa. IN PTR api.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. IN PTR api-int.ocp4.example.com. 2 ; 96.1.168.192.in-addr.arpa. IN PTR bootstrap.ocp4.example.com. 3 ; 97.1.168.192.in-addr.arpa. IN PTR control-plane0.ocp4.example.com. 4 98.1.168.192.in-addr.arpa. IN PTR control-plane1.ocp4.example.com. 5 99.1.168.192.in-addr.arpa. IN PTR control-plane2.ocp4.example.com. 6 ; 11.1.168.192.in-addr.arpa. IN PTR compute0.ocp4.example.com. 7 7.1.168.192.in-addr.arpa. IN PTR compute1.ocp4.example.com. 8 ; ;EOF", "global log 127.0.0.1 local2 pidfile /var/run/haproxy.pid maxconn 4000 daemon defaults mode http log global option dontlognull option http-server-close option redispatch retries 3 timeout http-request 10s timeout queue 1m timeout connect 10s timeout client 1m timeout server 1m timeout http-keep-alive 10s timeout check 10s maxconn 3000 listen api-server-6443 1 bind *:6443 mode tcp option httpchk GET /readyz HTTP/1.0 option log-health-checks balance roundrobin server bootstrap bootstrap.ocp4.example.com:6443 verify none check check-ssl inter 10s fall 2 rise 3 backup 2 server master0 master0.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master1 master1.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master2 master2.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 listen machine-config-server-22623 3 bind *:22623 mode tcp server bootstrap bootstrap.ocp4.example.com:22623 check inter 1s backup 4 server master0 master0.ocp4.example.com:22623 check inter 1s server master1 master1.ocp4.example.com:22623 check inter 1s server master2 master2.ocp4.example.com:22623 check inter 1s listen ingress-router-443 5 bind *:443 mode tcp balance source server worker0 worker0.ocp4.example.com:443 check inter 1s server worker1 worker1.ocp4.example.com:443 check inter 1s listen ingress-router-80 6 bind *:80 mode tcp balance source server worker0 worker0.ocp4.example.com:80 check inter 1s server worker1 worker1.ocp4.example.com:80 check inter 1s", "dig +noall +answer @<nameserver_ip> api.<cluster_name>.<base_domain> 1", "api.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> api-int.<cluster_name>.<base_domain>", "api-int.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> random.apps.<cluster_name>.<base_domain>", "random.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> console-openshift-console.apps.<cluster_name>.<base_domain>", "console-openshift-console.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> bootstrap.<cluster_name>.<base_domain>", "bootstrap.ocp4.example.com. 604800 IN A 192.168.1.96", "dig +noall +answer @<nameserver_ip> -x 192.168.1.5", "5.1.168.192.in-addr.arpa. 604800 IN PTR api-int.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. 604800 IN PTR api.ocp4.example.com. 2", "dig +noall +answer @<nameserver_ip> -x 192.168.1.96", "96.1.168.192.in-addr.arpa. 604800 IN PTR bootstrap.ocp4.example.com.", "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "tar -xvf openshift-install-linux.tar.gz", "tar xvf <file>", "echo USDPATH", "oc <command>", "C:\\> path", "C:\\> oc <command>", "echo USDPATH", "oc <command>", "mkdir <installation_directory>", "apiVersion: v1 baseDomain: example.com 1 compute: 2 - hyperthreading: Enabled 3 name: worker replicas: 0 4 architecture: s390x controlPlane: 5 hyperthreading: Enabled 6 name: master replicas: 3 7 architecture: s390x metadata: name: test 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 10 networkType: OVNKubernetes 11 serviceNetwork: 12 - 172.30.0.0/16 platform: none: {} 13 fips: false 14 pullSecret: '{\"auths\": ...}' 15 sshKey: 'ssh-ed25519 AAAA...' 16", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "compute: - name: worker platform: {} replicas: 0", "spec: clusterNetwork: - cidr: 10.128.0.0/19 hostPrefix: 23 - cidr: 10.128.32.0/19 hostPrefix: 23", "spec: serviceNetwork: - 172.30.0.0/14", "defaultNetwork: type: OpenShiftSDN openshiftSDNConfig: mode: NetworkPolicy mtu: 1450 vxlanPort: 4789", "defaultNetwork: type: OVNKubernetes ovnKubernetesConfig: mtu: 1400 genevePort: 6081 ipsecConfig: {}", "kubeProxyConfig: proxyArguments: iptables-min-sync-period: - 0s", "./openshift-install create manifests --dir <installation_directory> 1", "./openshift-install create ignition-configs --dir <installation_directory> 1", ". ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign", "prot_virt: Reserving <amount>MB as ultravisor base storage.", "cat /sys/firmware/uv/prot_virt_host", "1", "{ \"ignition\": { \"version\": \"3.0.0\" }, \"storage\": { \"files\": [ { \"path\": \"/etc/se-hostkeys/ibm-z-hostkey-<your-hostkey>.crt\", \"contents\": { \"source\": \"data:;base64,<base64 encoded hostkey document>\" }, \"mode\": 420 }, { \"path\": \"/etc/se-hostkeys/ibm-z-hostkey-<your-hostkey>.crt\", \"contents\": { \"source\": \"data:;base64,<base64 encoded hostkey document>\" }, \"mode\": 420 } ] } } ```", "base64 <your-hostkey>.crt", "gpg --recipient-file /path/to/ignition.gpg.pub --yes --output /path/to/config.ign.gpg --verbose --armor --encrypt /path/to/config.ign", "[ 2.801433] systemd[1]: Starting coreos-ignition-setup-user.service - CoreOS Ignition User Config Setup [ 2.803959] coreos-secex-ignition-decrypt[731]: gpg: key <key_name>: public key \"Secure Execution (secex) 38.20230323.dev.0\" imported [ 2.808874] coreos-secex-ignition-decrypt[740]: gpg: encrypted with rsa4096 key, ID <key_name>, created <yyyy-mm-dd> [ OK ] Finished coreos-secex-igni...S Secex Ignition Config Decryptor.", "Starting coreos-ignition-s...reOS Ignition User Config Setup [ 2.863675] coreos-secex-ignition-decrypt[729]: gpg: key <key_name>: public key \"Secure Execution (secex) 38.20230323.dev.0\" imported [ 2.869178] coreos-secex-ignition-decrypt[738]: gpg: encrypted with RSA key, ID <key_name> [ 2.870347] coreos-secex-ignition-decrypt[738]: gpg: public key decryption failed: No secret key [ 2.870371] coreos-secex-ignition-decrypt[738]: gpg: decryption failed: No secret key", "variant: openshift version: 4.13.0 metadata: name: master-storage labels: machineconfiguration.openshift.io/role: master storage: luks: - clevis: tang: - thumbprint: QcPr_NHFJammnRCA3fFMVdNBwjs url: http://clevis.example.com:7500 options: 1 - --cipher - aes-cbc-essiv:sha256 device: /dev/disk/by-partlabel/root label: luks-root name: root wipe_volume: true filesystems: - device: /dev/mapper/root format: xfs label: root wipe_filesystem: true openshift: fips: true 2", "coreos-installer pxe customize /root/rhcos-bootfiles/rhcos-<release>-live-initramfs.s390x.img --dest-device /dev/disk/by-id/scsi-<serial-number> --dest-karg-append ip=<ip-address>::<gateway-ip>:<subnet-mask>::<network-device>:none --dest-karg-append nameserver=<nameserver-ip> --dest-karg-append rd.neednet=1 -o /root/rhcos-bootfiles/<Node-name>-initramfs.s390x.img", "rd.neednet=1 console=ttysclp0 ignition.firstboot ignition.platform.id=metal coreos.live.rootfs_url=http://10.19.17.25/redhat/ocp/rhcos-413.86.202302201445-0/rhcos-413.86.202302201445-0-live-rootfs.s390x.img coreos.inst.ignition_url=http://bastion.ocp-cluster1.example.com:8080/ignition/master.ign ip=10.19.17.2::10.19.17.1:255.255.255.0::enbdd0:none nameserver=10.19.17.1 zfcp.allow_lun_scan=0 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000", "qemu-img create -f qcow2 -F qcow2 -b /var/lib/libvirt/images/{source_rhcos_qemu} /var/lib/libvirt/images/{vmname}.qcow2 {size}", "virt-install --noautoconsole --connect qemu:///system --name {vn_name} --memory {memory} --vcpus {vcpus} --disk {disk} --import --network network={network},mac={mac} --disk path={ign_file},format=raw,readonly=on,serial=ignition,startup_policy=optional 1", "virt-install --connect qemu:///system --name {vn_name} --vcpus {vcpus} --memory {memory_mb} --disk {vn_name}.qcow2,size={image_size| default(10,true)} --network network={virt_network_parm} --boot hd --location {media_location},kernel={rhcos_kernel},initrd={rhcos_initrd} --extra-args \"rd.neednet=1 coreos.inst.install_dev=/dev/vda coreos.live.rootfs_url={rhcos_liveos} ip={ip}::{default_gateway}:{subnet_mask_length}:{vn_name}:enc1:none:{MTU} nameserver={dns} coreos.inst.ignition_url={rhcos_ign}\" --noautoconsole --wait", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0::enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=10.10.10.3::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=::10.10.10.254::::", "rd.route=20.20.20.0/24:20.20.20.254:enp2s0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=::::core0.example.com:enp2s0:none", "ip=enp1s0:dhcp ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0.100:none vlan=enp2s0.100:enp2s0", "ip=enp2s0.100:dhcp vlan=enp2s0.100:enp2s0", "nameserver=1.1.1.1 nameserver=8.8.8.8", "./openshift-install --dir <installation_directory> wait-for bootstrap-complete \\ 1 --log-level=info 2", "INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443 INFO API v1.26.0 up INFO Waiting up to 30m0s for bootstrapping to complete INFO It is now safe to remove the bootstrap resources", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-mddf5 20m system:node:master-01.example.com Approved,Issued csr-z5rln 16m system:node:worker-21.example.com Approved,Issued", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs oc adm certificate approve", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "oc get pod -n openshift-image-registry -l docker-registry=default", "No resources found in openshift-image-registry namespace", "oc edit configs.imageregistry.operator.openshift.io", "storage: pvc: claim:", "oc get clusteroperator image-registry", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE image-registry 4.13 True False False 6h50m", "oc edit configs.imageregistry/cluster", "managementState: Removed", "managementState: Managed", "oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{\"spec\":{\"storage\":{\"emptyDir\":{}}}}'", "Error from server (NotFound): configs.imageregistry.operator.openshift.io \"cluster\" not found", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "./openshift-install --dir <installation_directory> wait-for install-complete 1", "INFO Waiting up to 30m0s for the cluster to initialize", "oc get pods --all-namespaces", "NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m", "oc logs <pod_name> -n <namespace> 1", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. IN MX 10 smtp.example.com. ; ; ns1.example.com. IN A 192.168.1.5 smtp.example.com. IN A 192.168.1.5 ; helper.example.com. IN A 192.168.1.5 helper.ocp4.example.com. IN A 192.168.1.5 ; api.ocp4.example.com. IN A 192.168.1.5 1 api-int.ocp4.example.com. IN A 192.168.1.5 2 ; *.apps.ocp4.example.com. IN A 192.168.1.5 3 ; bootstrap.ocp4.example.com. IN A 192.168.1.96 4 ; control-plane0.ocp4.example.com. IN A 192.168.1.97 5 control-plane1.ocp4.example.com. IN A 192.168.1.98 6 control-plane2.ocp4.example.com. IN A 192.168.1.99 7 ; compute0.ocp4.example.com. IN A 192.168.1.11 8 compute1.ocp4.example.com. IN A 192.168.1.7 9 ; ;EOF", "USDTTL 1W @ IN SOA ns1.example.com. root ( 2019070700 ; serial 3H ; refresh (3 hours) 30M ; retry (30 minutes) 2W ; expiry (2 weeks) 1W ) ; minimum (1 week) IN NS ns1.example.com. ; 5.1.168.192.in-addr.arpa. IN PTR api.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. IN PTR api-int.ocp4.example.com. 2 ; 96.1.168.192.in-addr.arpa. IN PTR bootstrap.ocp4.example.com. 3 ; 97.1.168.192.in-addr.arpa. IN PTR control-plane0.ocp4.example.com. 4 98.1.168.192.in-addr.arpa. IN PTR control-plane1.ocp4.example.com. 5 99.1.168.192.in-addr.arpa. IN PTR control-plane2.ocp4.example.com. 6 ; 11.1.168.192.in-addr.arpa. IN PTR compute0.ocp4.example.com. 7 7.1.168.192.in-addr.arpa. IN PTR compute1.ocp4.example.com. 8 ; ;EOF", "global log 127.0.0.1 local2 pidfile /var/run/haproxy.pid maxconn 4000 daemon defaults mode http log global option dontlognull option http-server-close option redispatch retries 3 timeout http-request 10s timeout queue 1m timeout connect 10s timeout client 1m timeout server 1m timeout http-keep-alive 10s timeout check 10s maxconn 3000 listen api-server-6443 1 bind *:6443 mode tcp option httpchk GET /readyz HTTP/1.0 option log-health-checks balance roundrobin server bootstrap bootstrap.ocp4.example.com:6443 verify none check check-ssl inter 10s fall 2 rise 3 backup 2 server master0 master0.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master1 master1.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 server master2 master2.ocp4.example.com:6443 weight 1 verify none check check-ssl inter 10s fall 2 rise 3 listen machine-config-server-22623 3 bind *:22623 mode tcp server bootstrap bootstrap.ocp4.example.com:22623 check inter 1s backup 4 server master0 master0.ocp4.example.com:22623 check inter 1s server master1 master1.ocp4.example.com:22623 check inter 1s server master2 master2.ocp4.example.com:22623 check inter 1s listen ingress-router-443 5 bind *:443 mode tcp balance source server worker0 worker0.ocp4.example.com:443 check inter 1s server worker1 worker1.ocp4.example.com:443 check inter 1s listen ingress-router-80 6 bind *:80 mode tcp balance source server worker0 worker0.ocp4.example.com:80 check inter 1s server worker1 worker1.ocp4.example.com:80 check inter 1s", "dig +noall +answer @<nameserver_ip> api.<cluster_name>.<base_domain> 1", "api.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> api-int.<cluster_name>.<base_domain>", "api-int.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> random.apps.<cluster_name>.<base_domain>", "random.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> console-openshift-console.apps.<cluster_name>.<base_domain>", "console-openshift-console.apps.ocp4.example.com. 604800 IN A 192.168.1.5", "dig +noall +answer @<nameserver_ip> bootstrap.<cluster_name>.<base_domain>", "bootstrap.ocp4.example.com. 604800 IN A 192.168.1.96", "dig +noall +answer @<nameserver_ip> -x 192.168.1.5", "5.1.168.192.in-addr.arpa. 604800 IN PTR api-int.ocp4.example.com. 1 5.1.168.192.in-addr.arpa. 604800 IN PTR api.ocp4.example.com. 2", "dig +noall +answer @<nameserver_ip> -x 192.168.1.96", "96.1.168.192.in-addr.arpa. 604800 IN PTR bootstrap.ocp4.example.com.", "ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 1", "cat <path>/<file_name>.pub", "cat ~/.ssh/id_ed25519.pub", "eval \"USD(ssh-agent -s)\"", "Agent pid 31874", "ssh-add <path>/<file_name> 1", "Identity added: /home/<you>/<path>/<file_name> (<computer_name>)", "mkdir <installation_directory>", "apiVersion: v1 baseDomain: example.com 1 compute: 2 - hyperthreading: Enabled 3 name: worker replicas: 0 4 architecture: s390x controlPlane: 5 hyperthreading: Enabled 6 name: master replicas: 3 7 architecture: s390x metadata: name: test 8 networking: clusterNetwork: - cidr: 10.128.0.0/14 9 hostPrefix: 23 10 networkType: OVNKubernetes 11 serviceNetwork: 12 - 172.30.0.0/16 platform: none: {} 13 fips: false 14 pullSecret: '{\"auths\":{\"<local_registry>\": {\"auth\": \"<credentials>\",\"email\": \"[email protected]\"}}}' 15 sshKey: 'ssh-ed25519 AAAA...' 16 additionalTrustBundle: | 17 -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- imageContentSources: 18 - mirrors: - <local_repository>/ocp4/openshift4 source: quay.io/openshift-release-dev/ocp-release - mirrors: - <local_repository>/ocp4/openshift4 source: quay.io/openshift-release-dev/ocp-v4.0-art-dev", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "compute: - name: worker platform: {} replicas: 0", "spec: clusterNetwork: - cidr: 10.128.0.0/19 hostPrefix: 23 - cidr: 10.128.32.0/19 hostPrefix: 23", "spec: serviceNetwork: - 172.30.0.0/14", "defaultNetwork: type: OpenShiftSDN openshiftSDNConfig: mode: NetworkPolicy mtu: 1450 vxlanPort: 4789", "defaultNetwork: type: OVNKubernetes ovnKubernetesConfig: mtu: 1400 genevePort: 6081 ipsecConfig: {}", "kubeProxyConfig: proxyArguments: iptables-min-sync-period: - 0s", "./openshift-install create manifests --dir <installation_directory> 1", "./openshift-install create ignition-configs --dir <installation_directory> 1", ". ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign", "prot_virt: Reserving <amount>MB as ultravisor base storage.", "cat /sys/firmware/uv/prot_virt_host", "1", "{ \"ignition\": { \"version\": \"3.0.0\" }, \"storage\": { \"files\": [ { \"path\": \"/etc/se-hostkeys/ibm-z-hostkey-<your-hostkey>.crt\", \"contents\": { \"source\": \"data:;base64,<base64 encoded hostkey document>\" }, \"mode\": 420 }, { \"path\": \"/etc/se-hostkeys/ibm-z-hostkey-<your-hostkey>.crt\", \"contents\": { \"source\": \"data:;base64,<base64 encoded hostkey document>\" }, \"mode\": 420 } ] } } ```", "base64 <your-hostkey>.crt", "gpg --recipient-file /path/to/ignition.gpg.pub --yes --output /path/to/config.ign.gpg --verbose --armor --encrypt /path/to/config.ign", "[ 2.801433] systemd[1]: Starting coreos-ignition-setup-user.service - CoreOS Ignition User Config Setup [ 2.803959] coreos-secex-ignition-decrypt[731]: gpg: key <key_name>: public key \"Secure Execution (secex) 38.20230323.dev.0\" imported [ 2.808874] coreos-secex-ignition-decrypt[740]: gpg: encrypted with rsa4096 key, ID <key_name>, created <yyyy-mm-dd> [ OK ] Finished coreos-secex-igni...S Secex Ignition Config Decryptor.", "Starting coreos-ignition-s...reOS Ignition User Config Setup [ 2.863675] coreos-secex-ignition-decrypt[729]: gpg: key <key_name>: public key \"Secure Execution (secex) 38.20230323.dev.0\" imported [ 2.869178] coreos-secex-ignition-decrypt[738]: gpg: encrypted with RSA key, ID <key_name> [ 2.870347] coreos-secex-ignition-decrypt[738]: gpg: public key decryption failed: No secret key [ 2.870371] coreos-secex-ignition-decrypt[738]: gpg: decryption failed: No secret key", "variant: openshift version: 4.13.0 metadata: name: master-storage labels: machineconfiguration.openshift.io/role: master storage: luks: - clevis: tang: - thumbprint: QcPr_NHFJammnRCA3fFMVdNBwjs url: http://clevis.example.com:7500 options: 1 - --cipher - aes-cbc-essiv:sha256 device: /dev/disk/by-partlabel/root label: luks-root name: root wipe_volume: true filesystems: - device: /dev/mapper/root format: xfs label: root wipe_filesystem: true openshift: fips: true 2", "coreos-installer pxe customize /root/rhcos-bootfiles/rhcos-<release>-live-initramfs.s390x.img --dest-device /dev/disk/by-id/scsi-<serial-number> --dest-karg-append ip=<ip-address>::<gateway-ip>:<subnet-mask>::<network-device>:none --dest-karg-append nameserver=<nameserver-ip> --dest-karg-append rd.neednet=1 -o /root/rhcos-bootfiles/<Node-name>-initramfs.s390x.img", "rd.neednet=1 console=ttysclp0 ignition.firstboot ignition.platform.id=metal coreos.live.rootfs_url=http://10.19.17.25/redhat/ocp/rhcos-413.86.202302201445-0/rhcos-413.86.202302201445-0-live-rootfs.s390x.img coreos.inst.ignition_url=http://bastion.ocp-cluster1.example.com:8080/ignition/master.ign ip=10.19.17.2::10.19.17.1:255.255.255.0::enbdd0:none nameserver=10.19.17.1 zfcp.allow_lun_scan=0 rd.znet=qeth,0.0.bdd0,0.0.bdd1,0.0.bdd2,layer2=1 rd.zfcp=0.0.5677,0x600606680g7f0056,0x034F000000000000", "qemu-img create -f qcow2 -F qcow2 -b /var/lib/libvirt/images/{source_rhcos_qemu} /var/lib/libvirt/images/{vmname}.qcow2 {size}", "virt-install --noautoconsole --connect qemu:///system --name {vn_name} --memory {memory} --vcpus {vcpus} --disk {disk} --import --network network={network},mac={mac} --disk path={ign_file},format=raw,readonly=on,serial=ignition,startup_policy=optional 1", "virt-install --connect qemu:///system --name {vn_name} --vcpus {vcpus} --memory {memory_mb} --disk {vn_name}.qcow2,size={image_size| default(10,true)} --network network={virt_network_parm} --boot hd --location {media_location},kernel={rhcos_kernel},initrd={rhcos_initrd} --extra-args \"rd.neednet=1 coreos.inst.install_dev=/dev/vda coreos.live.rootfs_url={rhcos_liveos} ip={ip}::{default_gateway}:{subnet_mask_length}:{vn_name}:enc1:none:{MTU} nameserver={dns} coreos.inst.ignition_url={rhcos_ign}\" --noautoconsole --wait", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0::enp1s0:none nameserver=4.4.4.41", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=10.10.10.3::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=::10.10.10.254::::", "rd.route=20.20.20.0/24:20.20.20.254:enp2s0", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none ip=::::core0.example.com:enp2s0:none", "ip=enp1s0:dhcp ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none", "ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp2s0.100:none vlan=enp2s0.100:enp2s0", "ip=enp2s0.100:dhcp vlan=enp2s0.100:enp2s0", "nameserver=1.1.1.1 nameserver=8.8.8.8", "./openshift-install --dir <installation_directory> wait-for bootstrap-complete \\ 1 --log-level=info 2", "INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443 INFO API v1.26.0 up INFO Waiting up to 30m0s for bootstrapping to complete INFO It is now safe to remove the bootstrap resources", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs oc adm certificate approve", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "oc patch OperatorHub cluster --type json -p '[{\"op\": \"add\", \"path\": \"/spec/disableAllDefaultSources\", \"value\": true}]'", "oc get pod -n openshift-image-registry -l docker-registry=default", "No resources found in openshift-image-registry namespace", "oc edit configs.imageregistry.operator.openshift.io", "storage: pvc: claim:", "oc get clusteroperator image-registry", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE image-registry 4.13 True False False 6h50m", "oc edit configs.imageregistry/cluster", "managementState: Removed", "managementState: Managed", "oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{\"spec\":{\"storage\":{\"emptyDir\":{}}}}'", "Error from server (NotFound): configs.imageregistry.operator.openshift.io \"cluster\" not found", "watch -n5 oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.13.0 True False False 19m baremetal 4.13.0 True False False 37m cloud-credential 4.13.0 True False False 40m cluster-autoscaler 4.13.0 True False False 37m config-operator 4.13.0 True False False 38m console 4.13.0 True False False 26m csi-snapshot-controller 4.13.0 True False False 37m dns 4.13.0 True False False 37m etcd 4.13.0 True False False 36m image-registry 4.13.0 True False False 31m ingress 4.13.0 True False False 30m insights 4.13.0 True False False 31m kube-apiserver 4.13.0 True False False 26m kube-controller-manager 4.13.0 True False False 36m kube-scheduler 4.13.0 True False False 36m kube-storage-version-migrator 4.13.0 True False False 37m machine-api 4.13.0 True False False 29m machine-approver 4.13.0 True False False 37m machine-config 4.13.0 True False False 36m marketplace 4.13.0 True False False 37m monitoring 4.13.0 True False False 29m network 4.13.0 True False False 38m node-tuning 4.13.0 True False False 37m openshift-apiserver 4.13.0 True False False 32m openshift-controller-manager 4.13.0 True False False 30m openshift-samples 4.13.0 True False False 32m operator-lifecycle-manager 4.13.0 True False False 37m operator-lifecycle-manager-catalog 4.13.0 True False False 37m operator-lifecycle-manager-packageserver 4.13.0 True False False 32m service-ca 4.13.0 True False False 38m storage 4.13.0 True False False 37m", "./openshift-install --dir <installation_directory> wait-for install-complete 1", "INFO Waiting up to 30m0s for the cluster to initialize", "oc get pods --all-namespaces", "NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m", "oc logs <pod_name> -n <namespace> 1", "{ \"auths\":{ \"cloud.openshift.com\":{ \"auth\":\"b3Blb=\", \"email\":\"[email protected]\" }, \"quay.io\":{ \"auth\":\"b3Blb=\", \"email\":\"[email protected]\" } } }", "networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 - cidr: fd00:10:128::/56 hostPrefix: 64 serviceNetwork: - 172.30.0.0/16 - fd00:172:16::/112", "networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23", "networking: serviceNetwork: - 172.30.0.0/16", "networking: machineNetwork: - cidr: 10.0.0.0/16" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html-single/installing_on_ibm_z_and_ibm_linuxone/index
Chapter 4. Adding certification components
Chapter 4. Adding certification components 4.1. For OpenStack infrastructure containerized applications After creating the new product listing, add the certification components for the newly created product listing. You can configure the following options for the newly added components: Note The component configurations differ for different product categories. Section 4.1.1, "Images" Section 4.1.2, "Certification" Section 4.1.3, "Security" Section 4.1.4, "Repository information" Section 4.1.5, "Component details" Section 4.1.6, "Contact information for containerized applications" Section 4.1.7, "Associated products" To configure the options, go to the Components tab and click on any of the existing components. 4.1.1. Images The Images tab provides the test results for the container images that you submit by using the preflight tool. You have to configure preflight and push your container images to view the test results. To push your container images, click Set up Preflight . For detailed instructions about certification testing, see Running the certification test suite . When your testing is complete you can see two categories of images: Manifest Digests - denotes container images that are available for multiple architectures. Standalone Container Images - denotes container images that are available only for a single architecture. This page provides the following details of your container images: Specific image ID or the SHA ID Image Tag(s) Certification - Certified or Not certified, pass or fail status based on the checks performed. Click on it for more details. Architecture - specific architecture of your image, if applicable. Security - check for any vulnerabilities, if any. Health Index - Container Health Index is a measure of the oldest and most severe security updates available for a container image. 'A' is more up-to-date than 'F'. See Container Health Index grades as used inside the Red Hat Container Catalog for more details. Created - the day on which you submitted the certification. Click the Actions menu to perform the following tasks: Delete Image - click this option to delete your container image when your image is unpublished. Sync Tags - when you have altered your image tag, use this option to synchronize the container image information available on both Red Hat Partner Connect and Red Hat Container catalog . View in Catalog - When your container image is published, click this option to view the published container image on the Red Hat Ecosystem Container catalog . Click Publish , to publish your certified container images. 4.1.2. Certification The Certification tab provides detailed information about the Export control questionnaire and all the certification tests performed for the attached container images. Export Control Questionnaire The Export control questionnaire contains a series of questions through which the Red Hat legal team evaluates the export compliance by third-party vendors. Partner's legal representative must review and answer the questions. Red Hat takes approximately five business days to evaluate the responses and based on the responses Red Hat approves partner or declines partner or defers decision or requests more information. Click Start questionnaire , to enter all the legal information about your product. Click Review to modify the existing details. Note If you are using a version of Universal Base Image (UBI) to build your container image, you can host your image in a private repository. This allows you to skip the Export Compliance questionnaire. This form is required only if you are hosting your images on the Red Hat Container Catalog . Validate the functionality of your product on this Red Hat OpenStack release Validate the functionality of your product on this Red Hat OpenStack release by using the Certification tab. You can perform the following functions: Run the Red Hat Certification Tool locally. Share the test results with the Red Hat certification team. Interact with the certification team, if required. To validate the functionality of your product perform the following steps: If you are a new partner, click Request a partner subscription . When your request is approved, you get active subscriptions added to your account. When you have active partner subscriptions, then click Start certification and then click Go to Red Hat certification tool . A new certification case gets created on the Red Hat Certification portal , and you are redirected to the appropriate certification portal page. The certification team will contact you to start the certification testing process, and will follow up with you in case of a problem. After successful verification, a green check mark is displayed with the validate complete message. To review the validated product details, click Review . Submit your container image for verification Run the certification suite on your container image. See Running the certification test suite . Upload the test results. You can later see the test results on the Images tab. Publish the container image certification on the Red Hat catalog. Note This step certifies your container only. Use the Certifications tab to certify the functionality. 4.1.3. Security The security tab provides the health status of the attached product components. Red Hat uses a Health Index to identify security risks with your components that Red Hat provides through the Red Hat Ecosystem Catalog . The Health Index is a measure of the oldest and most severe security updates available for a container image. An image with a grade of 'A' is more up-to-date than one with a grade of 'F. For more information, see Container Health Index grades as used inside the Red Hat Container Catalog . This tab provides the health index of your images which includes the following details: Image ID Health index 4.1.4. Repository information You can configure the registry and repository details by using the Repository information tab. Enter the required details in the following fields: Field name Description Container registry namespace Registry name set when the container was created. This field becomes non-editable when the container gets published. Outbound repository name Repository name that you have selected or the name obtained from your private registry in which your image is hosted, for example, ubi-minimal. Repository summary Repository summary obtained from the container image. Repository description Repository description obtained from the container image. Instructions for users to get your company's image on the Red Hat Container catalog Provide specific instructions that you want users to follow when they get your container image. This field is applicable only for container images. After configuring all the mandatory fields click Save . Note All the fields marked with an asterisk * are required and must be completed before you can proceed with container certification. 4.1.5. Component details Configure the product component details by using this tab. Enter the required details in the following fields: Field name Description Image Type Select the respective image type for your product component. Standalone image - Select this type if you want your image to be deployed either by your product or by users. Component image - Select this type if you want your image to be deployed by your product and not by users. Application categories Select the respective application type of your software product. Host level access Select between the two options: Unprivileged - If your container is isolated from the host. or Privileged - If your container requires special host-level privileges. Note If your product's functionality requires root access, you must select the privileged option, before running the preflight tool. This setting is subject to Red Hat review. Release Category Select between the two options: Generally Available - When you select this option, the application is generally available and supported. or Beta - When you select this option, the application is available as a pre-release candidate. Project name Name of the project for internal purposes. 4.1.6. Contact information for containerized applications Note Providing information for this tab is optional. In the Contact Information tab, enter the primary technical contact details of your product component. Optional: In the Technical contact email address field, enter the email address of the image maintainer. Optional: To add additional contacts for your component, click + Add new contact . Click Save . 4.1.7. Associated products The Associated Product tab provides the list of products that are associated with your product component along with the following information: Product Name Type Visibility - Published or Not Published Last Activity - number of days before you ran the test To add products to your component, perform the following: If you want to find a product by its name, enter the product name in the Search by name text box and click the search icon. If you are not sure of the product name, click Find a product . From the Add product dialog, select the required product from the Available products list box and click the forward arrow. The selected product is added to the Chosen products list box. Click Update attached products . Added products are listed in the Associated product list. Note All the fields marked with an asterisk * are required and must be completed before you can proceed with the certification. 4.2. For OpenStack infrastructure non-containerized applications After creating the new product listing, add the certification components for the newly created product listing. You can configure the following options for the newly added components: Note The component configurations differ for different product categories. Section 4.2.1, "Certification for non-containers" Section 4.2.2, "Component Details" Section 4.2.3, "Contact Information for non containers" Section 4.2.4, "Associated products for non containers" To configure the component options, go to the Components tab and click on any of the existing components. 4.2.1. Certification for non-containers Validate the functionality of your product on this Red Hat OpenStack release Validate the functionality of your product on this Red Hat OpenStack release by using the Certification tab. This feature allows you to perform the following functions: Run the Red Hat Certification Tool locally. Share the test results with the Red Hat certification team. Interact with the certification team, if required. To validate the functionality of your product, perform the following steps: If you are a new partner, click Request a partner subscription . When your request is approved, you get active subscriptions added to your account. When you have active partner subscriptions, then click Start certification . Click Go to Red Hat certification tool . A new certification case gets created on the Red Hat Certification portal , and you are redirected to the appropriate component portal page. This page has four tabs: Summary - It includes the Certification Case, Partner Product and Progress details of the new certification case. On the Summary tab, navigate to the Files section and click Upload , to upload your test results. Add any relevant comments in the Discussions section, and then click Add Comment . Test Plans - displays the Test Plan Summary details of the new certification case. Related Certifications - displays the details of the related certification cases. Properties - displays the certification properties. It includes the following details: General - Provide the base certification version and platform information for your product certification and click Update Values : Platform - Select the required information for the following fields from the respective drop-down list: Product Version Base Version Support Case - Add any existing support cases or knowledge base articles that you want to reference with your certification case. OpenStack - Provide the details of the Red Hat OpenStack plugin components for certification and click Update . All the provided details along with the selected features and their respective protocols are available on the CertOps hub. The certification team will contact you to start the certification testing process and will follow up with you in case of a problem. After successful verification, a green check mark is displayed with the validate complete message. To review the validated product details, click Review . 4.2.2. Component Details Enter the required component details in the following fields: Component name - Enter the component name. This name is not published and is only for internal use. Red Hat OpenStack Version - Specifies the Red Hat OpenStack version on which you certify your non-containerized application component. This field is auto-populated with the required OpenStack version. Click Save . 4.2.3. Contact Information for non containers Note Providing information for this tab is optional. In the Contact Information tab, enter the primary technical contact details of your product component. Optional: In the Technical contact email address field, enter the email address of the image maintainer. Optional: To add additional contacts for your component, click + Add new contact . Click Save . 4.2.4. Associated products for non containers The Associated Product tab provides the list of products that are associated with your product component along with the following information: Product Name Type Visibility - Published or Not Published Last Activity - number of days before you ran the test To add products to your component, perform the following: If you want to find a product by its name, enter the product name in the Search by name text box and click the search icon. If you are not sure of the product name, click Find a product . From the Add product dialog, select the required product from the Available products list box and click the forward arrow. The selected product is added to the Chosen products list box. Click Update attached products . Added products are listed in the Associated product list. Note All the fields marked with an asterisk * are required and must be completed before you can proceed with the certification.
null
https://docs.redhat.com/en/documentation/red_hat_software_certification/2025/html/red_hat_openstack_services_on_openshift_certification_workflow_guide/adding-certification-components_create-a-product
Chapter 3. Identity providers
Chapter 3. Identity providers In the Quarkus Security framework, identity providers play a crucial role in authentication and authorization by verifying user identities. IdentityProvider creates a SecurityIdentity instance, which gets used during user authentication to verify and authorize access requests to your Quarkus application. IdentityProvider converts the authentication credentials provided by HttpAuthenticationMechanism to a SecurityIdentity instance. Some extensions, for example, OIDC , OAuth2 , and SmallRye JWT , have inline IdentityProvider implementations specific to the supported authentication flow. For example, quarkus-oidc uses its own IdentityProvider to convert a token to a SecurityIdentity instance. If you use Basic or form-based authentication, you must add an IdentityProvider instance to convert a username and password to a SecurityIdentity instance. To get started with security in Quarkus, consider combining the Quarkus built-in Basic HTTP authentication with the Jakarta Persistence identity provider to enable role-based access control (RBAC). For more information about Basic authentication, its mechanisms, and related identity providers, see the following resources: Quarkus Security with Jakarta Persistence Getting started with Security by using Basic authentication and Jakarta Persistence Form-based authentication Using security with JDBC Using security with an LDAP realm Quarkus Security overview
null
https://docs.redhat.com/en/documentation/red_hat_build_of_quarkus/3.8/html/security_architecture/security-identity-providers
Registry
Registry OpenShift Container Platform 4.15 Configuring registries for OpenShift Container Platform Red Hat OpenShift Documentation Team
null
https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/registry/index
Chapter 8. The XFS File System
Chapter 8. The XFS File System XFS is a highly scalable, high-performance file system which was originally designed at Silicon Graphics, Inc. It was created to support extremely large filesystems (up to 16 exabytes), files (8 exabytes) and directory structures (tens of millions of entries). Main Features XFS supports metadata journaling , which facilitates quicker crash recovery. The XFS file system can also be defragmented and enlarged while mounted and active. In addition, Red Hat Enterprise Linux 6 supports backup and restore utilities specific to XFS. Allocation Features XFS features the following allocation schemes: Extent-based allocation Stripe-aware allocation policies Delayed allocation Space pre-allocation Delayed allocation and other performance optimizations affect XFS the same way that they do ext4. Namely, a program's writes to an XFS file system are not guaranteed to be on-disk unless the program issues an fsync() call afterwards. For more information on the implications of delayed allocation on a file system, refer to Allocation Features in Chapter 6, The Ext4 File System . The workaround for ensuring writes to disk applies to XFS as well. Other XFS Features The XFS file system also supports the following: Extended attributes ( xattr ) This allows the system to associate several additional name/value pairs per file. Quota journaling This avoids the need for lengthy quota consistency checks after a crash. Project/directory quotas This allows quota restrictions over a directory tree. Subsecond timestamps This allows timestamps to go to the subsecond. 8.1. Creating an XFS File System To create an XFS file system, use the mkfs.xfs /dev/ device command. In general, the default options are optimal for common use. When using mkfs.xfs on a block device containing an existing file system, use the -f option to force an overwrite of that file system. Example 8.1. mkfs.xfs command output Below is a sample output of the mkfs.xfs command: Note After an XFS file system is created, its size cannot be reduced. However, it can still be enlarged using the xfs_growfs command (refer to Section 8.4, "Increasing the Size of an XFS File System" ). For striped block devices (for example, RAID5 arrays), the stripe geometry can be specified at the time of file system creation. Using proper stripe geometry greatly enhances the performance of an XFS filesystem. When creating filesystems on LVM or MD volumes, mkfs.xfs chooses an optimal geometry. This may also be true on some hardware RAIDs that export geometry information to the operating system. To specify stripe geometry, use the following mkfs.xfs sub-options: su= value Specifies a stripe unit or RAID chunk size. The value must be specified in bytes, with an optional k , m , or g suffix. sw= value Specifies the number of data disks in a RAID device, or the number of stripe units in the stripe. The following example specifies a chunk size of 64k on a RAID device containing 4 stripe units: For more information about creating XFS file systems, refer to man mkfs.xfs .
[ "meta-data=/dev/device isize=256 agcount=4, agsize=3277258 blks = sectsz=512 attr=2 data = bsize=4096 blocks=13109032, imaxpct=25 = sunit=0 swidth=0 blks naming =version 2 bsize=4096 ascii-ci=0 log =internal log bsize=4096 blocks=6400, version=2 = sectsz=512 sunit=0 blks, lazy-count=1 realtime =none extsz=4096 blocks=0, rtextents=0", "mkfs.xfs -d su=64k,sw=4 /dev/ device" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/storage_administration_guide/ch-xfs
Chapter 13. Installing a cluster on GCP in a restricted network with user-provisioned infrastructure
Chapter 13. Installing a cluster on GCP in a restricted network with user-provisioned infrastructure In OpenShift Container Platform version 4.13, you can install a cluster on Google Cloud Platform (GCP) that uses infrastructure that you provide and an internal mirror of the installation release content. Important While you can install an OpenShift Container Platform cluster by using mirrored installation release content, your cluster still requires internet access to use the GCP APIs. The steps for performing a user-provided infrastructure install are outlined here. Several Deployment Manager templates are provided to assist in completing these steps or to help model your own. You are also free to create the required resources through other methods. Important The steps for performing a user-provisioned infrastructure installation are provided as an example only. Installing a cluster with infrastructure you provide requires knowledge of the cloud provider and the installation process of OpenShift Container Platform. Several Deployment Manager templates are provided to assist in completing these steps or to help model your own. You are also free to create the required resources through other methods; the templates are just an example. 13.1. Prerequisites You reviewed details about the OpenShift Container Platform installation and update processes. You read the documentation on selecting a cluster installation method and preparing it for users . You created a registry on your mirror host and obtained the imageContentSources data for your version of OpenShift Container Platform. Important Because the installation media is on the mirror host, you can use that computer to complete all installation steps. If you use a firewall, you configured it to allow the sites that your cluster requires access to. While you might need to grant access to more sites, you must grant access to *.googleapis.com and accounts.google.com . If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the kube-system namespace, you can manually create and maintain IAM credentials . 13.2. About installations in restricted networks In OpenShift Container Platform 4.13, you can perform an installation that does not require an active connection to the internet to obtain software components. Restricted network installations can be completed using installer-provisioned infrastructure or user-provisioned infrastructure, depending on the cloud platform to which you are installing the cluster. If you choose to perform a restricted network installation on a cloud platform, you still require access to its cloud APIs. Some cloud functions, like Amazon Web Service's Route 53 DNS and IAM services, require internet access. Depending on your network, you might require less internet access for an installation on bare metal hardware, Nutanix, or on VMware vSphere. To complete a restricted network installation, you must create a registry that mirrors the contents of the OpenShift image registry and contains the installation media. You can create this registry on a mirror host, which can access both the internet and your closed network, or by using other methods that meet your restrictions. Important Because of the complexity of the configuration for user-provisioned installations, consider completing a standard user-provisioned infrastructure installation before you attempt a restricted network installation using user-provisioned infrastructure. Completing this test installation might make it easier to isolate and troubleshoot any issues that might arise during your installation in a restricted network. 13.2.1. Additional limits Clusters in restricted networks have the following additional limitations and restrictions: The ClusterVersion status includes an Unable to retrieve available updates error. By default, you cannot use the contents of the Developer Catalog because you cannot access the required image stream tags. 13.3. Internet access for OpenShift Container Platform In OpenShift Container Platform 4.13, you require access to the internet to obtain the images that are necessary to install your cluster. You must have internet access to: Access OpenShift Cluster Manager Hybrid Cloud Console to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. Access Quay.io to obtain the packages that are required to install your cluster. Obtain the packages that are required to perform cluster updates. 13.4. Configuring your GCP project Before you can install OpenShift Container Platform, you must configure a Google Cloud Platform (GCP) project to host it. 13.4.1. Creating a GCP project To install OpenShift Container Platform, you must create a project in your Google Cloud Platform (GCP) account to host the cluster. Procedure Create a project to host your OpenShift Container Platform cluster. See Creating and Managing Projects in the GCP documentation. Important Your GCP project must use the Premium Network Service Tier if you are using installer-provisioned infrastructure. The Standard Network Service Tier is not supported for clusters installed using the installation program. The installation program configures internal load balancing for the api-int.<cluster_name>.<base_domain> URL; the Premium Tier is required for internal load balancing. 13.4.2. Enabling API services in GCP Your Google Cloud Platform (GCP) project requires access to several API services to complete OpenShift Container Platform installation. Prerequisites You created a project to host your cluster. Procedure Enable the following required API services in the project that hosts your cluster. You may also enable optional API services which are not required for installation. See Enabling services in the GCP documentation. Table 13.1. Required API services API service Console service name Compute Engine API compute.googleapis.com Cloud Resource Manager API cloudresourcemanager.googleapis.com Google DNS API dns.googleapis.com IAM Service Account Credentials API iamcredentials.googleapis.com Identity and Access Management (IAM) API iam.googleapis.com Service Usage API serviceusage.googleapis.com Table 13.2. Optional API services API service Console service name Google Cloud APIs cloudapis.googleapis.com Service Management API servicemanagement.googleapis.com Google Cloud Storage JSON API storage-api.googleapis.com Cloud Storage storage-component.googleapis.com 13.4.3. Configuring DNS for GCP To install OpenShift Container Platform, the Google Cloud Platform (GCP) account you use must have a dedicated public hosted zone in the same project that you host the OpenShift Container Platform cluster. This zone must be authoritative for the domain. The DNS service provides cluster DNS resolution and name lookup for external connections to the cluster. Procedure Identify your domain, or subdomain, and registrar. You can transfer an existing domain and registrar or obtain a new one through GCP or another source. Note If you purchase a new domain, it can take time for the relevant DNS changes to propagate. For more information about purchasing domains through Google, see Google Domains . Create a public hosted zone for your domain or subdomain in your GCP project. See Creating public zones in the GCP documentation. Use an appropriate root domain, such as openshiftcorp.com , or subdomain, such as clusters.openshiftcorp.com . Extract the new authoritative name servers from the hosted zone records. See Look up your Cloud DNS name servers in the GCP documentation. You typically have four name servers. Update the registrar records for the name servers that your domain uses. For example, if you registered your domain to Google Domains, see the following topic in the Google Domains Help: How to switch to custom name servers . If you migrated your root domain to Google Cloud DNS, migrate your DNS records. See Migrating to Cloud DNS in the GCP documentation. If you use a subdomain, follow your company's procedures to add its delegation records to the parent domain. This process might include a request to your company's IT department or the division that controls the root domain and DNS services for your company. 13.4.4. GCP account limits The OpenShift Container Platform cluster uses a number of Google Cloud Platform (GCP) components, but the default Quotas do not affect your ability to install a default OpenShift Container Platform cluster. A default cluster, which contains three compute and three control plane machines, uses the following resources. Note that some resources are required only during the bootstrap process and are removed after the cluster deploys. Table 13.3. GCP resources used in a default cluster Service Component Location Total resources required Resources removed after bootstrap Service account IAM Global 6 1 Firewall rules Networking Global 11 1 Forwarding rules Compute Global 2 0 Health checks Compute Global 2 0 Images Compute Global 1 0 Networks Networking Global 1 0 Routers Networking Global 1 0 Routes Networking Global 2 0 Subnetworks Compute Global 2 0 Target pools Networking Global 2 0 Note If any of the quotas are insufficient during installation, the installation program displays an error that states both which quota was exceeded and the region. Be sure to consider your actual cluster size, planned cluster growth, and any usage from other clusters that are associated with your account. The CPU, static IP addresses, and persistent disk SSD (storage) quotas are the ones that are most likely to be insufficient. If you plan to deploy your cluster in one of the following regions, you will exceed the maximum storage quota and are likely to exceed the CPU quota limit: asia-east2 asia-northeast2 asia-south1 australia-southeast1 europe-north1 europe-west2 europe-west3 europe-west6 northamerica-northeast1 southamerica-east1 us-west2 You can increase resource quotas from the GCP console , but you might need to file a support ticket. Be sure to plan your cluster size early so that you can allow time to resolve the support ticket before you install your OpenShift Container Platform cluster. 13.4.5. Creating a service account in GCP OpenShift Container Platform requires a Google Cloud Platform (GCP) service account that provides authentication and authorization to access data in the Google APIs. If you do not have an existing IAM service account that contains the required roles in your project, you must create one. Prerequisites You created a project to host your cluster. Procedure Create a service account in the project that you use to host your OpenShift Container Platform cluster. See Creating a service account in the GCP documentation. Grant the service account the appropriate permissions. You can either grant the individual permissions that follow or assign the Owner role to it. See Granting roles to a service account for specific resources . Note While making the service account an owner of the project is the easiest way to gain the required permissions, it means that service account has complete control over the project. You must determine if the risk that comes from offering that power is acceptable. You can create the service account key in JSON format, or attach the service account to a GCP virtual machine. See Creating service account keys and Creating and enabling service accounts for instances in the GCP documentation. You must have a service account key or a virtual machine with an attached service account to create the cluster. Note If you use a virtual machine with an attached service account to create your cluster, you must set credentialsMode: Manual in the install-config.yaml file before installation. 13.4.6. Required GCP roles When you attach the Owner role to the service account that you create, you grant that service account all permissions, including those that are required to install OpenShift Container Platform. If the security policies for your organization require a more restrictive set of permissions, you can create a service account with the following permissions. Important If you configure the Cloud Credential Operator to operate in passthrough mode, you must use roles rather than granular permissions. If you deploy your cluster into an existing virtual private cloud (VPC), the service account does not require certain networking permissions, which are noted in the following lists: Required roles for the installation program Compute Admin IAM Security Admin Service Account Admin Service Account Key Admin Service Account User Storage Admin Required roles for creating network resources during installation DNS Administrator Required roles for using passthrough credentials mode Compute Load Balancer Admin IAM Role Viewer Required roles for user-provisioned GCP infrastructure Deployment Manager Editor The roles are applied to the service accounts that the control plane and compute machines use: Table 13.4. GCP service account permissions Account Roles Control Plane roles/compute.instanceAdmin roles/compute.networkAdmin roles/compute.securityAdmin roles/storage.admin roles/iam.serviceAccountUser Compute roles/compute.viewer roles/storage.admin 13.4.7. Required GCP permissions for user-provisioned infrastructure When you attach the Owner role to the service account that you create, you grant that service account all permissions, including those that are required to install OpenShift Container Platform. If the security policies for your organization require a more restrictive set of permissions, you can create custom roles with the necessary permissions. The following permissions are required for the user-provisioned infrastructure for creating and deleting the OpenShift Container Platform cluster. Important If you configure the Cloud Credential Operator to operate in passthrough mode, you must use roles rather than granular permissions. For more information, see "Required roles for using passthrough credentials mode" in the "Required GCP roles" section. Example 13.1. Required permissions for creating network resources compute.addresses.create compute.addresses.createInternal compute.addresses.delete compute.addresses.get compute.addresses.list compute.addresses.use compute.addresses.useInternal compute.firewalls.create compute.firewalls.delete compute.firewalls.get compute.firewalls.list compute.forwardingRules.create compute.forwardingRules.get compute.forwardingRules.list compute.forwardingRules.setLabels compute.networks.create compute.networks.get compute.networks.list compute.networks.updatePolicy compute.routers.create compute.routers.get compute.routers.list compute.routers.update compute.routes.list compute.subnetworks.create compute.subnetworks.get compute.subnetworks.list compute.subnetworks.use compute.subnetworks.useExternalIp Example 13.2. Required permissions for creating load balancer resources compute.regionBackendServices.create compute.regionBackendServices.get compute.regionBackendServices.list compute.regionBackendServices.update compute.regionBackendServices.use compute.targetPools.addInstance compute.targetPools.create compute.targetPools.get compute.targetPools.list compute.targetPools.removeInstance compute.targetPools.use Example 13.3. Required permissions for creating DNS resources dns.changes.create dns.changes.get dns.managedZones.create dns.managedZones.get dns.managedZones.list dns.networks.bindPrivateDNSZone dns.resourceRecordSets.create dns.resourceRecordSets.list dns.resourceRecordSets.update Example 13.4. Required permissions for creating Service Account resources iam.serviceAccountKeys.create iam.serviceAccountKeys.delete iam.serviceAccountKeys.get iam.serviceAccountKeys.list iam.serviceAccounts.actAs iam.serviceAccounts.create iam.serviceAccounts.delete iam.serviceAccounts.get iam.serviceAccounts.list resourcemanager.projects.get resourcemanager.projects.getIamPolicy resourcemanager.projects.setIamPolicy Example 13.5. Required permissions for creating compute resources compute.disks.create compute.disks.get compute.disks.list compute.instanceGroups.create compute.instanceGroups.delete compute.instanceGroups.get compute.instanceGroups.list compute.instanceGroups.update compute.instanceGroups.use compute.instances.create compute.instances.delete compute.instances.get compute.instances.list compute.instances.setLabels compute.instances.setMetadata compute.instances.setServiceAccount compute.instances.setTags compute.instances.use compute.machineTypes.get compute.machineTypes.list Example 13.6. Required for creating storage resources storage.buckets.create storage.buckets.delete storage.buckets.get storage.buckets.list storage.objects.create storage.objects.delete storage.objects.get storage.objects.list Example 13.7. Required permissions for creating health check resources compute.healthChecks.create compute.healthChecks.get compute.healthChecks.list compute.healthChecks.useReadOnly compute.httpHealthChecks.create compute.httpHealthChecks.get compute.httpHealthChecks.list compute.httpHealthChecks.useReadOnly Example 13.8. Required permissions to get GCP zone and region related information compute.globalOperations.get compute.regionOperations.get compute.regions.list compute.zoneOperations.get compute.zones.get compute.zones.list Example 13.9. Required permissions for checking services and quotas monitoring.timeSeries.list serviceusage.quotas.get serviceusage.services.list Example 13.10. Required IAM permissions for installation iam.roles.get Example 13.11. Required Images permissions for installation compute.images.create compute.images.delete compute.images.get compute.images.list Example 13.12. Optional permission for running gather bootstrap compute.instances.getSerialPortOutput Example 13.13. Required permissions for deleting network resources compute.addresses.delete compute.addresses.deleteInternal compute.addresses.list compute.firewalls.delete compute.firewalls.list compute.forwardingRules.delete compute.forwardingRules.list compute.networks.delete compute.networks.list compute.networks.updatePolicy compute.routers.delete compute.routers.list compute.routes.list compute.subnetworks.delete compute.subnetworks.list Example 13.14. Required permissions for deleting load balancer resources compute.regionBackendServices.delete compute.regionBackendServices.list compute.targetPools.delete compute.targetPools.list Example 13.15. Required permissions for deleting DNS resources dns.changes.create dns.managedZones.delete dns.managedZones.get dns.managedZones.list dns.resourceRecordSets.delete dns.resourceRecordSets.list Example 13.16. Required permissions for deleting Service Account resources iam.serviceAccounts.delete iam.serviceAccounts.get iam.serviceAccounts.list resourcemanager.projects.getIamPolicy resourcemanager.projects.setIamPolicy Example 13.17. Required permissions for deleting compute resources compute.disks.delete compute.disks.list compute.instanceGroups.delete compute.instanceGroups.list compute.instances.delete compute.instances.list compute.instances.stop compute.machineTypes.list Example 13.18. Required for deleting storage resources storage.buckets.delete storage.buckets.getIamPolicy storage.buckets.list storage.objects.delete storage.objects.list Example 13.19. Required permissions for deleting health check resources compute.healthChecks.delete compute.healthChecks.list compute.httpHealthChecks.delete compute.httpHealthChecks.list Example 13.20. Required Images permissions for deletion compute.images.delete compute.images.list Example 13.21. Required permissions to get Region related information compute.regions.get Example 13.22. Required Deployment Manager permissions deploymentmanager.deployments.create deploymentmanager.deployments.delete deploymentmanager.deployments.get deploymentmanager.deployments.list deploymentmanager.manifests.get deploymentmanager.operations.get deploymentmanager.resources.list Additional resources Optimizing storage 13.4.8. Supported GCP regions You can deploy an OpenShift Container Platform cluster to the following Google Cloud Platform (GCP) regions: asia-east1 (Changhua County, Taiwan) asia-east2 (Hong Kong) asia-northeast1 (Tokyo, Japan) asia-northeast2 (Osaka, Japan) asia-northeast3 (Seoul, South Korea) asia-south1 (Mumbai, India) asia-south2 (Delhi, India) asia-southeast1 (Jurong West, Singapore) asia-southeast2 (Jakarta, Indonesia) australia-southeast1 (Sydney, Australia) australia-southeast2 (Melbourne, Australia) europe-central2 (Warsaw, Poland) europe-north1 (Hamina, Finland) europe-southwest1 (Madrid, Spain) europe-west1 (St. Ghislain, Belgium) europe-west2 (London, England, UK) europe-west3 (Frankfurt, Germany) europe-west4 (Eemshaven, Netherlands) europe-west6 (Zurich, Switzerland) europe-west8 (Milan, Italy) europe-west9 (Paris, France) europe-west12 (Turin, Italy) me-central1 (Doha, Qatar, Middle East) me-west1 (Tel Aviv, Israel) northamerica-northeast1 (Montreal, Quebec, Canada) northamerica-northeast2 (Toronto, Ontario, Canada) southamerica-east1 (Sao Paulo, Brazil) southamerica-west1 (Santiago, Chile) us-central1 (Council Bluffs, Iowa, USA) us-east1 (Moncks Corner, South Carolina, USA) us-east4 (Ashburn, Northern Virginia, USA) us-east5 (Columbus, Ohio) us-south1 (Dallas, Texas) us-west1 (The Dalles, Oregon, USA) us-west2 (Los Angeles, California, USA) us-west3 (Salt Lake City, Utah, USA) us-west4 (Las Vegas, Nevada, USA) Note To determine which machine type instances are available by region and zone, see the Google documentation . 13.4.9. Installing and configuring CLI tools for GCP To install OpenShift Container Platform on Google Cloud Platform (GCP) using user-provisioned infrastructure, you must install and configure the CLI tools for GCP. Prerequisites You created a project to host your cluster. You created a service account and granted it the required permissions. Procedure Install the following binaries in USDPATH : gcloud gsutil See Install the latest Cloud SDK version in the GCP documentation. Authenticate using the gcloud tool with your configured service account. See Authorizing with a service account in the GCP documentation. 13.5. Requirements for a cluster with user-provisioned infrastructure For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. This section describes the requirements for deploying OpenShift Container Platform on user-provisioned infrastructure. 13.5.1. Required machines for cluster installation The smallest OpenShift Container Platform clusters require the following hosts: Table 13.5. Minimum required hosts Hosts Description One temporary bootstrap machine The cluster requires the bootstrap machine to deploy the OpenShift Container Platform cluster on the three control plane machines. You can remove the bootstrap machine after you install the cluster. Three control plane machines The control plane machines run the Kubernetes and OpenShift Container Platform services that form the control plane. At least two compute machines, which are also known as worker machines. The workloads requested by OpenShift Container Platform users run on the compute machines. Important To maintain high availability of your cluster, use separate physical hosts for these cluster machines. The bootstrap and control plane machines must use Red Hat Enterprise Linux CoreOS (RHCOS) as the operating system. However, the compute machines can choose between Red Hat Enterprise Linux CoreOS (RHCOS), Red Hat Enterprise Linux (RHEL) 8.6 and later. Note that RHCOS is based on Red Hat Enterprise Linux (RHEL) 9.2 and inherits all of its hardware certifications and requirements. See Red Hat Enterprise Linux technology capabilities and limits . 13.5.2. Minimum resource requirements for cluster installation Each cluster machine must meet the following minimum requirements: Table 13.6. Minimum resource requirements Machine Operating System vCPU [1] Virtual RAM Storage Input/Output Per Second (IOPS) [2] Bootstrap RHCOS 4 16 GB 100 GB 300 Control plane RHCOS 4 16 GB 100 GB 300 Compute RHCOS, RHEL 8.6 and later [3] 2 8 GB 100 GB 300 One vCPU is equivalent to one physical core when simultaneous multithreading (SMT), or Hyper-Threading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core x cores) x sockets = vCPUs. OpenShift Container Platform and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance. As with all user-provisioned installations, if you choose to use RHEL compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of RHEL 7 compute machines is deprecated and has been removed in OpenShift Container Platform 4.10 and later. Note As of OpenShift Container Platform version 4.13, RHCOS is based on RHEL version 9.2, which updates the micro-architecture requirements. The following list contains the minimum instruction set architectures (ISA) that each architecture requires: x86-64 architecture requires x86-64-v2 ISA ARM64 architecture requires ARMv8.0-A ISA IBM Power architecture requires Power 9 ISA s390x architecture requires z14 ISA For more information, see RHEL Architectures . If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OpenShift Container Platform. 13.5.3. Tested instance types for GCP The following Google Cloud Platform instance types have been tested with OpenShift Container Platform. Example 13.23. Machine series A2 A3 C2 C2D C3 C3D C4 E2 M1 N1 N2 N2D N4 Tau T2D 13.5.4. Using custom machine types Using a custom machine type to install a OpenShift Container Platform cluster is supported. Consider the following when using a custom machine type: Similar to predefined instance types, custom machine types must meet the minimum resource requirements for control plane and compute machines. For more information, see "Minimum resource requirements for cluster installation". The name of the custom machine type must adhere to the following syntax: custom-<number_of_cpus>-<amount_of_memory_in_mb> For example, custom-6-20480 . 13.6. Creating the installation files for GCP To install OpenShift Container Platform on Google Cloud Platform (GCP) using user-provisioned infrastructure, you must generate the files that the installation program needs to deploy your cluster and modify them so that the cluster creates only the machines that it will use. You generate and customize the install-config.yaml file, Kubernetes manifests, and Ignition config files. You also have the option to first set up a separate var partition during the preparation phases of installation. 13.6.1. Optional: Creating a separate /var partition It is recommended that disk partitioning for OpenShift Container Platform be left to the installer. However, there are cases where you might want to create separate partitions in a part of the filesystem that you expect to grow. OpenShift Container Platform supports the addition of a single partition to attach storage to either the /var partition or a subdirectory of /var . For example: /var/lib/containers : Holds container-related content that can grow as more images and containers are added to a system. /var/lib/etcd : Holds data that you might want to keep separate for purposes such as performance optimization of etcd storage. /var : Holds data that you might want to keep separate for purposes such as auditing. Storing the contents of a /var directory separately makes it easier to grow storage for those areas as needed and reinstall OpenShift Container Platform at a later date and keep that data intact. With this method, you will not have to pull all your containers again, nor will you have to copy massive log files when you update systems. Because /var must be in place before a fresh installation of Red Hat Enterprise Linux CoreOS (RHCOS), the following procedure sets up the separate /var partition by creating a machine config manifest that is inserted during the openshift-install preparation phases of an OpenShift Container Platform installation. Important If you follow the steps to create a separate /var partition in this procedure, it is not necessary to create the Kubernetes manifest and Ignition config files again as described later in this section. Procedure Create a directory to hold the OpenShift Container Platform installation files: USD mkdir USDHOME/clusterconfig Run openshift-install to create a set of files in the manifest and openshift subdirectories. Answer the system questions as you are prompted: USD openshift-install create manifests --dir USDHOME/clusterconfig Example output ? SSH Public Key ... INFO Credentials loaded from the "myprofile" profile in file "/home/myuser/.aws/credentials" INFO Consuming Install Config from target directory INFO Manifests created in: USDHOME/clusterconfig/manifests and USDHOME/clusterconfig/openshift Optional: Confirm that the installation program created manifests in the clusterconfig/openshift directory: USD ls USDHOME/clusterconfig/openshift/ Example output 99_kubeadmin-password-secret.yaml 99_openshift-cluster-api_master-machines-0.yaml 99_openshift-cluster-api_master-machines-1.yaml 99_openshift-cluster-api_master-machines-2.yaml ... Create a Butane config that configures the additional partition. For example, name the file USDHOME/clusterconfig/98-var-partition.bu , change the disk device name to the name of the storage device on the worker systems, and set the storage size as appropriate. This example places the /var directory on a separate partition: variant: openshift version: 4.13.0 metadata: labels: machineconfiguration.openshift.io/role: worker name: 98-var-partition storage: disks: - device: /dev/disk/by-id/<device_name> 1 partitions: - label: var start_mib: <partition_start_offset> 2 size_mib: <partition_size> 3 number: 5 filesystems: - device: /dev/disk/by-partlabel/var path: /var format: xfs mount_options: [defaults, prjquota] 4 with_mount_unit: true 1 The storage device name of the disk that you want to partition. 2 When adding a data partition to the boot disk, a minimum value of 25000 MiB (Mebibytes) is recommended. The root file system is automatically resized to fill all available space up to the specified offset. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of RHCOS might overwrite the beginning of the data partition. 3 The size of the data partition in mebibytes. 4 The prjquota mount option must be enabled for filesystems used for container storage. Note When creating a separate /var partition, you cannot use different instance types for worker nodes, if the different instance types do not have the same device name. Create a manifest from the Butane config and save it to the clusterconfig/openshift directory. For example, run the following command: USD butane USDHOME/clusterconfig/98-var-partition.bu -o USDHOME/clusterconfig/openshift/98-var-partition.yaml Run openshift-install again to create Ignition configs from a set of files in the manifest and openshift subdirectories: USD openshift-install create ignition-configs --dir USDHOME/clusterconfig USD ls USDHOME/clusterconfig/ auth bootstrap.ign master.ign metadata.json worker.ign Now you can use the Ignition config files as input to the installation procedures to install Red Hat Enterprise Linux CoreOS (RHCOS) systems. 13.6.2. Creating the installation configuration file You can customize the OpenShift Container Platform cluster you install on Google Cloud Platform (GCP). Prerequisites Obtain the OpenShift Container Platform installation program and the pull secret for your cluster. For a restricted network installation, these files are on your mirror host. Have the imageContentSources values that were generated during mirror registry creation. Obtain the contents of the certificate for your mirror registry. Obtain service principal permissions at the subscription level. Procedure Create the install-config.yaml file. Change to the directory that contains the installation program and run the following command: USD ./openshift-install create install-config --dir <installation_directory> 1 1 For <installation_directory> , specify the directory name to store the files that the installation program creates. When specifying the directory: Verify that the directory has the execute permission. This permission is required to run Terraform binaries under the installation directory. Use an empty directory. Some installation assets, such as bootstrap X.509 certificates, have short expiration intervals, therefore you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. Note Always delete the ~/.powervs directory to avoid reusing a stale configuration. Run the following command: USD rm -rf ~/.powervs At the prompts, provide the configuration details for your cloud: Optional: Select an SSH key to use to access your cluster machines. Note For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses. Select gcp as the platform to target. If you have not configured the service account key for your GCP account on your computer, you must obtain it from GCP and paste the contents of the file or enter the absolute path to the file. Select the project ID to provision the cluster in. The default value is specified by the service account that you configured. Select the region to deploy the cluster to. Select the base domain to deploy the cluster to. The base domain corresponds to the public DNS zone that you created for your cluster. Enter a descriptive name for your cluster. Paste the pull secret from the Red Hat OpenShift Cluster Manager . Edit the install-config.yaml file to give the additional information that is required for an installation in a restricted network. Update the pullSecret value to contain the authentication information for your registry: pullSecret: '{"auths":{"<mirror_host_name>:5000": {"auth": "<credentials>","email": "[email protected]"}}}' For <mirror_host_name> , specify the registry domain name that you specified in the certificate for your mirror registry, and for <credentials> , specify the base64-encoded user name and password for your mirror registry. Add the additionalTrustBundle parameter and value. additionalTrustBundle: | -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry. Define the network and subnets for the VPC to install the cluster in under the parent platform.gcp field: network: <existing_vpc> controlPlaneSubnet: <control_plane_subnet> computeSubnet: <compute_subnet> For platform.gcp.network , specify the name for the existing Google VPC. For platform.gcp.controlPlaneSubnet and platform.gcp.computeSubnet , specify the existing subnets to deploy the control plane machines and compute machines, respectively. Add the image content resources, which resemble the following YAML excerpt: imageContentSources: - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: registry.redhat.io/ocp/release For these values, use the imageContentSources that you recorded during mirror registry creation. Make any other modifications to the install-config.yaml file that you require. You can find more information about the available parameters in the Installation configuration parameters section. Back up the install-config.yaml file so that you can use it to install multiple clusters. Important The install-config.yaml file is consumed during the installation process. If you want to reuse the file, you must back it up now. 13.6.3. Enabling Shielded VMs You can use Shielded VMs when installing your cluster. Shielded VMs have extra security features including secure boot, firmware and integrity monitoring, and rootkit detection. For more information, see Google's documentation on Shielded VMs . Prerequisites You have created an install-config.yaml file. Procedure Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add one of the following stanzas: To use shielded VMs for only control plane machines: controlPlane: platform: gcp: secureBoot: Enabled To use shielded VMs for only compute machines: compute: - platform: gcp: secureBoot: Enabled To use shielded VMs for all machines: platform: gcp: defaultMachinePlatform: secureBoot: Enabled 13.6.4. Enabling Confidential VMs You can use Confidential VMs when installing your cluster. Confidential VMs encrypt data while it is being processed. For more information, see Google's documentation on Confidential Computing . You can enable Confidential VMs and Shielded VMs at the same time, although they are not dependent on each other. Important Confidential Computing is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope . Important Due to a known issue in OpenShift Container Platform 4.13.3 and earlier versions, you cannot use persistent volume storage on a cluster with Confidential VMs on Google Cloud Platform (GCP). This issue was resolved in OpenShift Container Platform 4.13.4. For more information, see OCPBUGS-11768 . Prerequisites You have created an install-config.yaml file. Procedure Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add one of the following stanzas: To use confidential VMs for only control plane machines: controlPlane: platform: gcp: confidentialCompute: Enabled 1 type: n2d-standard-8 2 onHostMaintenance: Terminate 3 1 Enable confidential VMs. 2 Specify a machine type that supports Confidential VMs. Confidential VMs require the N2D or C2D series of machine types. For more information on supported machine types, see Supported operating systems and machine types . 3 Specify the behavior of the VM during a host maintenance event, such as a hardware or software update. For a machine that uses Confidential VM, this value must be set to Terminate , which stops the VM. Confidential VMs do not support live VM migration. To use confidential VMs for only compute machines: compute: - platform: gcp: confidentialCompute: Enabled type: n2d-standard-8 onHostMaintenance: Terminate To use confidential VMs for all machines: platform: gcp: defaultMachinePlatform: confidentialCompute: Enabled type: n2d-standard-8 onHostMaintenance: Terminate 13.6.5. Configuring the cluster-wide proxy during installation Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the install-config.yaml file. Prerequisites You have an existing install-config.yaml file. You reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object's spec.noProxy field to bypass the proxy if necessary. Note The Proxy object status.noProxy field is populated with the values of the networking.machineNetwork[].cidr , networking.clusterNetwork[].cidr , and networking.serviceNetwork[] fields from your installation configuration. For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the Proxy object status.noProxy field is also populated with the instance metadata endpoint ( 169.254.169.254 ). Procedure Edit your install-config.yaml file and add the proxy settings. For example: apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5 1 A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http . 2 A proxy URL to use for creating HTTPS connections outside the cluster. 3 A comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with . to match subdomains only. For example, .y.com matches x.y.com , but not y.com . Use * to bypass the proxy for all destinations. 4 If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy's identity certificate is signed by an authority from the RHCOS trust bundle. 5 Optional: The policy to determine the configuration of the Proxy object to reference the user-ca-bundle config map in the trustedCA field. The allowed values are Proxyonly and Always . Use Proxyonly to reference the user-ca-bundle config map only when http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly . Note The installation program does not support the proxy readinessEndpoints field. Note If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example: USD ./openshift-install wait-for install-complete --log-level debug Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec . Note Only the Proxy object named cluster is supported, and no additional proxies can be created. 13.6.6. Creating the Kubernetes manifest and Ignition config files Because you must modify some cluster definition files and manually start the cluster machines, you must generate the Kubernetes manifest and Ignition config files that the cluster needs to configure the machines. The installation configuration file transforms into the Kubernetes manifests. The manifests wrap into the Ignition configuration files, which are later used to configure the cluster machines. Important The Ignition config files that the OpenShift Container Platform installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending node-bootstrapper certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. Prerequisites You obtained the OpenShift Container Platform installation program. For a restricted network installation, these files are on your mirror host. You created the install-config.yaml installation configuration file. Procedure Change to the directory that contains the OpenShift Container Platform installation program and generate the Kubernetes manifests for the cluster: USD ./openshift-install create manifests --dir <installation_directory> 1 1 For <installation_directory> , specify the installation directory that contains the install-config.yaml file you created. Remove the Kubernetes manifest files that define the control plane machines: USD rm -f <installation_directory>/openshift/99_openshift-cluster-api_master-machines-*.yaml By removing these files, you prevent the cluster from automatically generating control plane machines. Remove the Kubernetes manifest files that define the control plane machine set: USD rm -f <installation_directory>/openshift/99_openshift-machine-api_master-control-plane-machine-set.yaml Optional: If you do not want the cluster to provision compute machines, remove the Kubernetes manifest files that define the worker machines: USD rm -f <installation_directory>/openshift/99_openshift-cluster-api_worker-machineset-*.yaml Because you create and manage the worker machines yourself, you do not need to initialize these machines. Check that the mastersSchedulable parameter in the <installation_directory>/manifests/cluster-scheduler-02-config.yml Kubernetes manifest file is set to false . This setting prevents pods from being scheduled on the control plane machines: Open the <installation_directory>/manifests/cluster-scheduler-02-config.yml file. Locate the mastersSchedulable parameter and ensure that it is set to false . Save and exit the file. Optional: If you do not want the Ingress Operator to create DNS records on your behalf, remove the privateZone and publicZone sections from the <installation_directory>/manifests/cluster-dns-02-config.yml DNS configuration file: apiVersion: config.openshift.io/v1 kind: DNS metadata: creationTimestamp: null name: cluster spec: baseDomain: example.openshift.com privateZone: 1 id: mycluster-100419-private-zone publicZone: 2 id: example.openshift.com status: {} 1 2 Remove this section completely. If you do so, you must add ingress DNS records manually in a later step. To create the Ignition configuration files, run the following command from the directory that contains the installation program: USD ./openshift-install create ignition-configs --dir <installation_directory> 1 1 For <installation_directory> , specify the same installation directory. Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory. The kubeadmin-password and kubeconfig files are created in the ./<installation_directory>/auth directory: Additional resources Optional: Adding the ingress DNS records 13.7. Exporting common variables 13.7.1. Extracting the infrastructure name The Ignition config files contain a unique cluster identifier that you can use to uniquely identify your cluster in Google Cloud Platform (GCP). The infrastructure name is also used to locate the appropriate GCP resources during an OpenShift Container Platform installation. The provided Deployment Manager templates contain references to this infrastructure name, so you must extract it. Prerequisites You obtained the OpenShift Container Platform installation program and the pull secret for your cluster. You generated the Ignition config files for your cluster. You installed the jq package. Procedure To extract and view the infrastructure name from the Ignition config file metadata, run the following command: USD jq -r .infraID <installation_directory>/metadata.json 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Example output openshift-vw9j6 1 1 The output of this command is your cluster name and a random string. 13.7.2. Exporting common variables for Deployment Manager templates You must export a common set of variables that are used with the provided Deployment Manager templates used to assist in completing a user-provided infrastructure install on Google Cloud Platform (GCP). Note Specific Deployment Manager templates can also require additional exported variables, which are detailed in their related procedures. Prerequisites Obtain the OpenShift Container Platform installation program and the pull secret for your cluster. Generate the Ignition config files for your cluster. Install the jq package. Procedure Export the following common variables to be used by the provided Deployment Manager templates: USD export BASE_DOMAIN='<base_domain>' USD export BASE_DOMAIN_ZONE_NAME='<base_domain_zone_name>' USD export NETWORK_CIDR='10.0.0.0/16' USD export MASTER_SUBNET_CIDR='10.0.0.0/17' USD export WORKER_SUBNET_CIDR='10.0.128.0/17' USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 USD export CLUSTER_NAME=`jq -r .clusterName <installation_directory>/metadata.json` USD export INFRA_ID=`jq -r .infraID <installation_directory>/metadata.json` USD export PROJECT_NAME=`jq -r .gcp.projectID <installation_directory>/metadata.json` USD export REGION=`jq -r .gcp.region <installation_directory>/metadata.json` 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. 13.8. Creating a VPC in GCP You must create a VPC in Google Cloud Platform (GCP) for your OpenShift Container Platform cluster to use. You can customize the VPC to meet your requirements. One way to create the VPC is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your GCP infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Procedure Copy the template from the Deployment Manager template for the VPC section of this topic and save it as 01_vpc.py on your computer. This template describes the VPC that your cluster requires. Create a 01_vpc.yaml resource definition file: USD cat <<EOF >01_vpc.yaml imports: - path: 01_vpc.py resources: - name: cluster-vpc type: 01_vpc.py properties: infra_id: 'USD{INFRA_ID}' 1 region: 'USD{REGION}' 2 master_subnet_cidr: 'USD{MASTER_SUBNET_CIDR}' 3 worker_subnet_cidr: 'USD{WORKER_SUBNET_CIDR}' 4 EOF 1 infra_id is the INFRA_ID infrastructure name from the extraction step. 2 region is the region to deploy the cluster into, for example us-central1 . 3 master_subnet_cidr is the CIDR for the master subnet, for example 10.0.0.0/17 . 4 worker_subnet_cidr is the CIDR for the worker subnet, for example 10.0.128.0/17 . Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-vpc --config 01_vpc.yaml 13.8.1. Deployment Manager template for the VPC You can use the following Deployment Manager template to deploy the VPC that you need for your OpenShift Container Platform cluster: Example 13.24. 01_vpc.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-network', 'type': 'compute.v1.network', 'properties': { 'region': context.properties['region'], 'autoCreateSubnetworks': False } }, { 'name': context.properties['infra_id'] + '-master-subnet', 'type': 'compute.v1.subnetwork', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'ipCidrRange': context.properties['master_subnet_cidr'] } }, { 'name': context.properties['infra_id'] + '-worker-subnet', 'type': 'compute.v1.subnetwork', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'ipCidrRange': context.properties['worker_subnet_cidr'] } }, { 'name': context.properties['infra_id'] + '-router', 'type': 'compute.v1.router', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'nats': [{ 'name': context.properties['infra_id'] + '-nat-master', 'natIpAllocateOption': 'AUTO_ONLY', 'minPortsPerVm': 7168, 'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS', 'subnetworks': [{ 'name': 'USD(ref.' + context.properties['infra_id'] + '-master-subnet.selfLink)', 'sourceIpRangesToNat': ['ALL_IP_RANGES'] }] }, { 'name': context.properties['infra_id'] + '-nat-worker', 'natIpAllocateOption': 'AUTO_ONLY', 'minPortsPerVm': 512, 'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS', 'subnetworks': [{ 'name': 'USD(ref.' + context.properties['infra_id'] + '-worker-subnet.selfLink)', 'sourceIpRangesToNat': ['ALL_IP_RANGES'] }] }] } }] return {'resources': resources} 13.9. Networking requirements for user-provisioned infrastructure All the Red Hat Enterprise Linux CoreOS (RHCOS) machines require networking to be configured in initramfs during boot to fetch their Ignition config files. 13.9.1. Setting the cluster node hostnames through DHCP On Red Hat Enterprise Linux CoreOS (RHCOS) machines, the hostname is set through NetworkManager. By default, the machines obtain their hostname through DHCP. If the hostname is not provided by DHCP, set statically through kernel arguments, or another method, it is obtained through a reverse DNS lookup. Reverse DNS lookup occurs after the network has been initialized on a node and can take time to resolve. Other system services can start prior to this and detect the hostname as localhost or similar. You can avoid this by using DHCP to provide the hostname for each cluster node. Additionally, setting the hostnames through DHCP can bypass any manual DNS record name configuration errors in environments that have a DNS split-horizon implementation. 13.9.2. Network connectivity requirements You must configure the network connectivity between machines to allow OpenShift Container Platform cluster components to communicate. Each machine must be able to resolve the hostnames of all other machines in the cluster. This section provides details about the ports that are required. Table 13.7. Ports used for all-machine to all-machine communications Protocol Port Description ICMP N/A Network reachability tests TCP 1936 Metrics 9000 - 9999 Host level services, including the node exporter on ports 9100 - 9101 and the Cluster Version Operator on port 9099 . 10250 - 10259 The default ports that Kubernetes reserves 10256 openshift-sdn UDP 4789 VXLAN 6081 Geneve 9000 - 9999 Host level services, including the node exporter on ports 9100 - 9101 . 500 IPsec IKE packets 4500 IPsec NAT-T packets 123 Network Time Protocol (NTP) on UDP port 123 If an external NTP time server is configured, you must open UDP port 123 . TCP/UDP 30000 - 32767 Kubernetes node port ESP N/A IPsec Encapsulating Security Payload (ESP) Table 13.8. Ports used for all-machine to control plane communications Protocol Port Description TCP 6443 Kubernetes API Table 13.9. Ports used for control plane machine to control plane machine communications Protocol Port Description TCP 2379 - 2380 etcd server and peer ports 13.10. Creating load balancers in GCP You must configure load balancers in Google Cloud Platform (GCP) for your OpenShift Container Platform cluster to use. One way to create these components is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your GCP infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Procedure Copy the template from the Deployment Manager template for the internal load balancer section of this topic and save it as 02_lb_int.py on your computer. This template describes the internal load balancing objects that your cluster requires. For an external cluster, also copy the template from the Deployment Manager template for the external load balancer section of this topic and save it as 02_lb_ext.py on your computer. This template describes the external load balancing objects that your cluster requires. Export the variables that the deployment template uses: Export the cluster network location: USD export CLUSTER_NETWORK=(`gcloud compute networks describe USD{INFRA_ID}-network --format json | jq -r .selfLink`) Export the control plane subnet location: USD export CONTROL_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-master-subnet --region=USD{REGION} --format json | jq -r .selfLink`) Export the three zones that the cluster uses: USD export ZONE_0=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[0] | cut -d "/" -f9`) USD export ZONE_1=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[1] | cut -d "/" -f9`) USD export ZONE_2=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[2] | cut -d "/" -f9`) Create a 02_infra.yaml resource definition file: USD cat <<EOF >02_infra.yaml imports: - path: 02_lb_ext.py - path: 02_lb_int.py 1 resources: - name: cluster-lb-ext 2 type: 02_lb_ext.py properties: infra_id: 'USD{INFRA_ID}' 3 region: 'USD{REGION}' 4 - name: cluster-lb-int type: 02_lb_int.py properties: cluster_network: 'USD{CLUSTER_NETWORK}' control_subnet: 'USD{CONTROL_SUBNET}' 5 infra_id: 'USD{INFRA_ID}' region: 'USD{REGION}' zones: 6 - 'USD{ZONE_0}' - 'USD{ZONE_1}' - 'USD{ZONE_2}' EOF 1 2 Required only when deploying an external cluster. 3 infra_id is the INFRA_ID infrastructure name from the extraction step. 4 region is the region to deploy the cluster into, for example us-central1 . 5 control_subnet is the URI to the control subnet. 6 zones are the zones to deploy the control plane instances into, like us-east1-b , us-east1-c , and us-east1-d . Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-infra --config 02_infra.yaml Export the cluster IP address: USD export CLUSTER_IP=(`gcloud compute addresses describe USD{INFRA_ID}-cluster-ip --region=USD{REGION} --format json | jq -r .address`) For an external cluster, also export the cluster public IP address: USD export CLUSTER_PUBLIC_IP=(`gcloud compute addresses describe USD{INFRA_ID}-cluster-public-ip --region=USD{REGION} --format json | jq -r .address`) 13.10.1. Deployment Manager template for the external load balancer You can use the following Deployment Manager template to deploy the external load balancer that you need for your OpenShift Container Platform cluster: Example 13.25. 02_lb_ext.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-cluster-public-ip', 'type': 'compute.v1.address', 'properties': { 'region': context.properties['region'] } }, { # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver 'name': context.properties['infra_id'] + '-api-http-health-check', 'type': 'compute.v1.httpHealthCheck', 'properties': { 'port': 6080, 'requestPath': '/readyz' } }, { 'name': context.properties['infra_id'] + '-api-target-pool', 'type': 'compute.v1.targetPool', 'properties': { 'region': context.properties['region'], 'healthChecks': ['USD(ref.' + context.properties['infra_id'] + '-api-http-health-check.selfLink)'], 'instances': [] } }, { 'name': context.properties['infra_id'] + '-api-forwarding-rule', 'type': 'compute.v1.forwardingRule', 'properties': { 'region': context.properties['region'], 'IPAddress': 'USD(ref.' + context.properties['infra_id'] + '-cluster-public-ip.selfLink)', 'target': 'USD(ref.' + context.properties['infra_id'] + '-api-target-pool.selfLink)', 'portRange': '6443' } }] return {'resources': resources} 13.10.2. Deployment Manager template for the internal load balancer You can use the following Deployment Manager template to deploy the internal load balancer that you need for your OpenShift Container Platform cluster: Example 13.26. 02_lb_int.py Deployment Manager template def GenerateConfig(context): backends = [] for zone in context.properties['zones']: backends.append({ 'group': 'USD(ref.' + context.properties['infra_id'] + '-master-' + zone + '-ig' + '.selfLink)' }) resources = [{ 'name': context.properties['infra_id'] + '-cluster-ip', 'type': 'compute.v1.address', 'properties': { 'addressType': 'INTERNAL', 'region': context.properties['region'], 'subnetwork': context.properties['control_subnet'] } }, { # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver 'name': context.properties['infra_id'] + '-api-internal-health-check', 'type': 'compute.v1.healthCheck', 'properties': { 'httpsHealthCheck': { 'port': 6443, 'requestPath': '/readyz' }, 'type': "HTTPS" } }, { 'name': context.properties['infra_id'] + '-api-internal-backend-service', 'type': 'compute.v1.regionBackendService', 'properties': { 'backends': backends, 'healthChecks': ['USD(ref.' + context.properties['infra_id'] + '-api-internal-health-check.selfLink)'], 'loadBalancingScheme': 'INTERNAL', 'region': context.properties['region'], 'protocol': 'TCP', 'timeoutSec': 120 } }, { 'name': context.properties['infra_id'] + '-api-internal-forwarding-rule', 'type': 'compute.v1.forwardingRule', 'properties': { 'backendService': 'USD(ref.' + context.properties['infra_id'] + '-api-internal-backend-service.selfLink)', 'IPAddress': 'USD(ref.' + context.properties['infra_id'] + '-cluster-ip.selfLink)', 'loadBalancingScheme': 'INTERNAL', 'ports': ['6443','22623'], 'region': context.properties['region'], 'subnetwork': context.properties['control_subnet'] } }] for zone in context.properties['zones']: resources.append({ 'name': context.properties['infra_id'] + '-master-' + zone + '-ig', 'type': 'compute.v1.instanceGroup', 'properties': { 'namedPorts': [ { 'name': 'ignition', 'port': 22623 }, { 'name': 'https', 'port': 6443 } ], 'network': context.properties['cluster_network'], 'zone': zone } }) return {'resources': resources} You will need this template in addition to the 02_lb_ext.py template when you create an external cluster. 13.11. Creating a private DNS zone in GCP You must configure a private DNS zone in Google Cloud Platform (GCP) for your OpenShift Container Platform cluster to use. One way to create this component is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your GCP infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Procedure Copy the template from the Deployment Manager template for the private DNS section of this topic and save it as 02_dns.py on your computer. This template describes the private DNS objects that your cluster requires. Create a 02_dns.yaml resource definition file: USD cat <<EOF >02_dns.yaml imports: - path: 02_dns.py resources: - name: cluster-dns type: 02_dns.py properties: infra_id: 'USD{INFRA_ID}' 1 cluster_domain: 'USD{CLUSTER_NAME}.USD{BASE_DOMAIN}' 2 cluster_network: 'USD{CLUSTER_NETWORK}' 3 EOF 1 infra_id is the INFRA_ID infrastructure name from the extraction step. 2 cluster_domain is the domain for the cluster, for example openshift.example.com . 3 cluster_network is the selfLink URL to the cluster network. Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-dns --config 02_dns.yaml The templates do not create DNS entries due to limitations of Deployment Manager, so you must create them manually: Add the internal DNS entries: USD if [ -f transaction.yaml ]; then rm transaction.yaml; fi USD gcloud dns record-sets transaction start --zone USD{INFRA_ID}-private-zone USD gcloud dns record-sets transaction add USD{CLUSTER_IP} --name api.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{INFRA_ID}-private-zone USD gcloud dns record-sets transaction add USD{CLUSTER_IP} --name api-int.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{INFRA_ID}-private-zone USD gcloud dns record-sets transaction execute --zone USD{INFRA_ID}-private-zone For an external cluster, also add the external DNS entries: USD if [ -f transaction.yaml ]; then rm transaction.yaml; fi USD gcloud dns record-sets transaction start --zone USD{BASE_DOMAIN_ZONE_NAME} USD gcloud dns record-sets transaction add USD{CLUSTER_PUBLIC_IP} --name api.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{BASE_DOMAIN_ZONE_NAME} USD gcloud dns record-sets transaction execute --zone USD{BASE_DOMAIN_ZONE_NAME} 13.11.1. Deployment Manager template for the private DNS You can use the following Deployment Manager template to deploy the private DNS that you need for your OpenShift Container Platform cluster: Example 13.27. 02_dns.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-private-zone', 'type': 'dns.v1.managedZone', 'properties': { 'description': '', 'dnsName': context.properties['cluster_domain'] + '.', 'visibility': 'private', 'privateVisibilityConfig': { 'networks': [{ 'networkUrl': context.properties['cluster_network'] }] } } }] return {'resources': resources} 13.12. Creating firewall rules in GCP You must create firewall rules in Google Cloud Platform (GCP) for your OpenShift Container Platform cluster to use. One way to create these components is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your GCP infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Procedure Copy the template from the Deployment Manager template for firewall rules section of this topic and save it as 03_firewall.py on your computer. This template describes the security groups that your cluster requires. Create a 03_firewall.yaml resource definition file: USD cat <<EOF >03_firewall.yaml imports: - path: 03_firewall.py resources: - name: cluster-firewall type: 03_firewall.py properties: allowed_external_cidr: '0.0.0.0/0' 1 infra_id: 'USD{INFRA_ID}' 2 cluster_network: 'USD{CLUSTER_NETWORK}' 3 network_cidr: 'USD{NETWORK_CIDR}' 4 EOF 1 allowed_external_cidr is the CIDR range that can access the cluster API and SSH to the bootstrap host. For an internal cluster, set this value to USD{NETWORK_CIDR} . 2 infra_id is the INFRA_ID infrastructure name from the extraction step. 3 cluster_network is the selfLink URL to the cluster network. 4 network_cidr is the CIDR of the VPC network, for example 10.0.0.0/16 . Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-firewall --config 03_firewall.yaml 13.12.1. Deployment Manager template for firewall rules You can use the following Deployment Manager template to deploy the firewall rues that you need for your OpenShift Container Platform cluster: Example 13.28. 03_firewall.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-bootstrap-in-ssh', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['22'] }], 'sourceRanges': [context.properties['allowed_external_cidr']], 'targetTags': [context.properties['infra_id'] + '-bootstrap'] } }, { 'name': context.properties['infra_id'] + '-api', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['6443'] }], 'sourceRanges': [context.properties['allowed_external_cidr']], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-health-checks', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['6080', '6443', '22624'] }], 'sourceRanges': ['35.191.0.0/16', '130.211.0.0/22', '209.85.152.0/22', '209.85.204.0/22'], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-etcd', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['2379-2380'] }], 'sourceTags': [context.properties['infra_id'] + '-master'], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-control-plane', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['10257'] },{ 'IPProtocol': 'tcp', 'ports': ['10259'] },{ 'IPProtocol': 'tcp', 'ports': ['22623'] }], 'sourceTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-internal-network', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'icmp' },{ 'IPProtocol': 'tcp', 'ports': ['22'] }], 'sourceRanges': [context.properties['network_cidr']], 'targetTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ] } }, { 'name': context.properties['infra_id'] + '-internal-cluster', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'udp', 'ports': ['4789', '6081'] },{ 'IPProtocol': 'udp', 'ports': ['500', '4500'] },{ 'IPProtocol': 'esp', },{ 'IPProtocol': 'tcp', 'ports': ['9000-9999'] },{ 'IPProtocol': 'udp', 'ports': ['9000-9999'] },{ 'IPProtocol': 'tcp', 'ports': ['10250'] },{ 'IPProtocol': 'tcp', 'ports': ['30000-32767'] },{ 'IPProtocol': 'udp', 'ports': ['30000-32767'] }], 'sourceTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ], 'targetTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ] } }] return {'resources': resources} 13.13. Creating IAM roles in GCP You must create IAM roles in Google Cloud Platform (GCP) for your OpenShift Container Platform cluster to use. One way to create these components is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your GCP infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Procedure Copy the template from the Deployment Manager template for IAM roles section of this topic and save it as 03_iam.py on your computer. This template describes the IAM roles that your cluster requires. Create a 03_iam.yaml resource definition file: USD cat <<EOF >03_iam.yaml imports: - path: 03_iam.py resources: - name: cluster-iam type: 03_iam.py properties: infra_id: 'USD{INFRA_ID}' 1 EOF 1 infra_id is the INFRA_ID infrastructure name from the extraction step. Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-iam --config 03_iam.yaml Export the variable for the master service account: USD export MASTER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter "email~^USD{INFRA_ID}-m@USD{PROJECT_NAME}." --format json | jq -r '.[0].email'`) Export the variable for the worker service account: USD export WORKER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter "email~^USD{INFRA_ID}-w@USD{PROJECT_NAME}." --format json | jq -r '.[0].email'`) Export the variable for the subnet that hosts the compute machines: USD export COMPUTE_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-worker-subnet --region=USD{REGION} --format json | jq -r .selfLink`) The templates do not create the policy bindings due to limitations of Deployment Manager, so you must create them manually: USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{MASTER_SERVICE_ACCOUNT}" --role "roles/compute.instanceAdmin" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{MASTER_SERVICE_ACCOUNT}" --role "roles/compute.networkAdmin" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{MASTER_SERVICE_ACCOUNT}" --role "roles/compute.securityAdmin" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{MASTER_SERVICE_ACCOUNT}" --role "roles/iam.serviceAccountUser" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{MASTER_SERVICE_ACCOUNT}" --role "roles/storage.admin" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{WORKER_SERVICE_ACCOUNT}" --role "roles/compute.viewer" USD gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member "serviceAccount:USD{WORKER_SERVICE_ACCOUNT}" --role "roles/storage.admin" Create a service account key and store it locally for later use: USD gcloud iam service-accounts keys create service-account-key.json --iam-account=USD{MASTER_SERVICE_ACCOUNT} 13.13.1. Deployment Manager template for IAM roles You can use the following Deployment Manager template to deploy the IAM roles that you need for your OpenShift Container Platform cluster: Example 13.29. 03_iam.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-master-node-sa', 'type': 'iam.v1.serviceAccount', 'properties': { 'accountId': context.properties['infra_id'] + '-m', 'displayName': context.properties['infra_id'] + '-master-node' } }, { 'name': context.properties['infra_id'] + '-worker-node-sa', 'type': 'iam.v1.serviceAccount', 'properties': { 'accountId': context.properties['infra_id'] + '-w', 'displayName': context.properties['infra_id'] + '-worker-node' } }] return {'resources': resources} 13.14. Creating the RHCOS cluster image for the GCP infrastructure You must use a valid Red Hat Enterprise Linux CoreOS (RHCOS) image for Google Cloud Platform (GCP) for your OpenShift Container Platform nodes. Procedure Obtain the RHCOS image from the RHCOS image mirror page. Important The RHCOS images might not change with every release of OpenShift Container Platform. You must download an image with the highest version that is less than or equal to the OpenShift Container Platform version that you install. Use the image version that matches your OpenShift Container Platform version if it is available. The file name contains the OpenShift Container Platform version number in the format rhcos-<version>-<arch>-gcp.<arch>.tar.gz . Create the Google storage bucket: USD gsutil mb gs://<bucket_name> Upload the RHCOS image to the Google storage bucket: USD gsutil cp <downloaded_image_file_path>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz gs://<bucket_name> Export the uploaded RHCOS image location as a variable: USD export IMAGE_SOURCE=gs://<bucket_name>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz Create the cluster image: USD gcloud compute images create "USD{INFRA_ID}-rhcos-image" \ --source-uri="USD{IMAGE_SOURCE}" 13.15. Creating the bootstrap machine in GCP You must create the bootstrap machine in Google Cloud Platform (GCP) to use during OpenShift Container Platform cluster initialization. One way to create this machine is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your bootstrap machine, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Create and configure networking and load balancers in GCP. Create control plane and compute roles. Ensure pyOpenSSL is installed. Procedure Copy the template from the Deployment Manager template for the bootstrap machine section of this topic and save it as 04_bootstrap.py on your computer. This template describes the bootstrap machine that your cluster requires. Export the location of the Red Hat Enterprise Linux CoreOS (RHCOS) image that the installation program requires: USD export CLUSTER_IMAGE=(`gcloud compute images describe USD{INFRA_ID}-rhcos-image --format json | jq -r .selfLink`) Create a bucket and upload the bootstrap.ign file: USD gsutil mb gs://USD{INFRA_ID}-bootstrap-ignition USD gsutil cp <installation_directory>/bootstrap.ign gs://USD{INFRA_ID}-bootstrap-ignition/ Create a signed URL for the bootstrap instance to use to access the Ignition config. Export the URL from the output as a variable: USD export BOOTSTRAP_IGN=`gsutil signurl -d 1h service-account-key.json gs://USD{INFRA_ID}-bootstrap-ignition/bootstrap.ign | grep "^gs:" | awk '{print USD5}'` Create a 04_bootstrap.yaml resource definition file: USD cat <<EOF >04_bootstrap.yaml imports: - path: 04_bootstrap.py resources: - name: cluster-bootstrap type: 04_bootstrap.py properties: infra_id: 'USD{INFRA_ID}' 1 region: 'USD{REGION}' 2 zone: 'USD{ZONE_0}' 3 cluster_network: 'USD{CLUSTER_NETWORK}' 4 control_subnet: 'USD{CONTROL_SUBNET}' 5 image: 'USD{CLUSTER_IMAGE}' 6 machine_type: 'n1-standard-4' 7 root_volume_size: '128' 8 bootstrap_ign: 'USD{BOOTSTRAP_IGN}' 9 EOF 1 infra_id is the INFRA_ID infrastructure name from the extraction step. 2 region is the region to deploy the cluster into, for example us-central1 . 3 zone is the zone to deploy the bootstrap instance into, for example us-central1-b . 4 cluster_network is the selfLink URL to the cluster network. 5 control_subnet is the selfLink URL to the control subnet. 6 image is the selfLink URL to the RHCOS image. 7 machine_type is the machine type of the instance, for example n1-standard-4 . 8 root_volume_size is the boot disk size for the bootstrap machine. 9 bootstrap_ign is the URL output when creating a signed URL. Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-bootstrap --config 04_bootstrap.yaml The templates do not manage load balancer membership due to limitations of Deployment Manager, so you must add the bootstrap machine manually. Add the bootstrap instance to the internal load balancer instance group: USD gcloud compute instance-groups unmanaged add-instances \ USD{INFRA_ID}-bootstrap-ig --zone=USD{ZONE_0} --instances=USD{INFRA_ID}-bootstrap Add the bootstrap instance group to the internal load balancer backend service: USD gcloud compute backend-services add-backend \ USD{INFRA_ID}-api-internal-backend-service --region=USD{REGION} --instance-group=USD{INFRA_ID}-bootstrap-ig --instance-group-zone=USD{ZONE_0} 13.15.1. Deployment Manager template for the bootstrap machine You can use the following Deployment Manager template to deploy the bootstrap machine that you need for your OpenShift Container Platform cluster: Example 13.30. 04_bootstrap.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-bootstrap-public-ip', 'type': 'compute.v1.address', 'properties': { 'region': context.properties['region'] } }, { 'name': context.properties['infra_id'] + '-bootstrap', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zone'] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': '{"ignition":{"config":{"replace":{"source":"' + context.properties['bootstrap_ign'] + '"}},"version":"3.2.0"}}', }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'], 'accessConfigs': [{ 'natIP': 'USD(ref.' + context.properties['infra_id'] + '-bootstrap-public-ip.address)' }] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-bootstrap' ] }, 'zone': context.properties['zone'] } }, { 'name': context.properties['infra_id'] + '-bootstrap-ig', 'type': 'compute.v1.instanceGroup', 'properties': { 'namedPorts': [ { 'name': 'ignition', 'port': 22623 }, { 'name': 'https', 'port': 6443 } ], 'network': context.properties['cluster_network'], 'zone': context.properties['zone'] } }] return {'resources': resources} 13.16. Creating the control plane machines in GCP You must create the control plane machines in Google Cloud Platform (GCP) for your cluster to use. One way to create these machines is to modify the provided Deployment Manager template. Note If you do not use the provided Deployment Manager template to create your control plane machines, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Create and configure networking and load balancers in GCP. Create control plane and compute roles. Create the bootstrap machine. Procedure Copy the template from the Deployment Manager template for control plane machines section of this topic and save it as 05_control_plane.py on your computer. This template describes the control plane machines that your cluster requires. Export the following variable required by the resource definition: USD export MASTER_IGNITION=`cat <installation_directory>/master.ign` Create a 05_control_plane.yaml resource definition file: USD cat <<EOF >05_control_plane.yaml imports: - path: 05_control_plane.py resources: - name: cluster-control-plane type: 05_control_plane.py properties: infra_id: 'USD{INFRA_ID}' 1 zones: 2 - 'USD{ZONE_0}' - 'USD{ZONE_1}' - 'USD{ZONE_2}' control_subnet: 'USD{CONTROL_SUBNET}' 3 image: 'USD{CLUSTER_IMAGE}' 4 machine_type: 'n1-standard-4' 5 root_volume_size: '128' service_account_email: 'USD{MASTER_SERVICE_ACCOUNT}' 6 ignition: 'USD{MASTER_IGNITION}' 7 EOF 1 infra_id is the INFRA_ID infrastructure name from the extraction step. 2 zones are the zones to deploy the control plane instances into, for example us-central1-a , us-central1-b , and us-central1-c . 3 control_subnet is the selfLink URL to the control subnet. 4 image is the selfLink URL to the RHCOS image. 5 machine_type is the machine type of the instance, for example n1-standard-4 . 6 service_account_email is the email address for the master service account that you created. 7 ignition is the contents of the master.ign file. Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-control-plane --config 05_control_plane.yaml The templates do not manage load balancer membership due to limitations of Deployment Manager, so you must add the control plane machines manually. Run the following commands to add the control plane machines to the appropriate instance groups: USD gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_0}-ig --zone=USD{ZONE_0} --instances=USD{INFRA_ID}-master-0 USD gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_1}-ig --zone=USD{ZONE_1} --instances=USD{INFRA_ID}-master-1 USD gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_2}-ig --zone=USD{ZONE_2} --instances=USD{INFRA_ID}-master-2 For an external cluster, you must also run the following commands to add the control plane machines to the target pools: USD gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone="USD{ZONE_0}" --instances=USD{INFRA_ID}-master-0 USD gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone="USD{ZONE_1}" --instances=USD{INFRA_ID}-master-1 USD gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone="USD{ZONE_2}" --instances=USD{INFRA_ID}-master-2 13.16.1. Deployment Manager template for control plane machines You can use the following Deployment Manager template to deploy the control plane machines that you need for your OpenShift Container Platform cluster: Example 13.31. 05_control_plane.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-master-0', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][0] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][0] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][0] } }, { 'name': context.properties['infra_id'] + '-master-1', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][1] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][1] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][1] } }, { 'name': context.properties['infra_id'] + '-master-2', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][2] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][2] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][2] } }] return {'resources': resources} 13.17. Wait for bootstrap completion and remove bootstrap resources in GCP After you create all of the required infrastructure in Google Cloud Platform (GCP), wait for the bootstrap process to complete on the machines that you provisioned by using the Ignition config files that you generated with the installation program. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Create and configure networking and load balancers in GCP. Create control plane and compute roles. Create the bootstrap machine. Create the control plane machines. Procedure Change to the directory that contains the installation program and run the following command: USD ./openshift-install wait-for bootstrap-complete --dir <installation_directory> \ 1 --log-level info 2 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. 2 To view different installation details, specify warn , debug , or error instead of info . If the command exits without a FATAL warning, your production control plane has initialized. Delete the bootstrap resources: USD gcloud compute backend-services remove-backend USD{INFRA_ID}-api-internal-backend-service --region=USD{REGION} --instance-group=USD{INFRA_ID}-bootstrap-ig --instance-group-zone=USD{ZONE_0} USD gsutil rm gs://USD{INFRA_ID}-bootstrap-ignition/bootstrap.ign USD gsutil rb gs://USD{INFRA_ID}-bootstrap-ignition USD gcloud deployment-manager deployments delete USD{INFRA_ID}-bootstrap 13.18. Creating additional worker machines in GCP You can create worker machines in Google Cloud Platform (GCP) for your cluster to use by launching individual instances discretely or by automated processes outside the cluster, such as auto scaling groups. You can also take advantage of the built-in cluster scaling mechanisms and the machine API in OpenShift Container Platform. In this example, you manually launch one instance by using the Deployment Manager template. Additional instances can be launched by including additional resources of type 06_worker.py in the file. Note If you do not use the provided Deployment Manager template to create your worker machines, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs. Prerequisites Configure a GCP account. Generate the Ignition config files for your cluster. Create and configure a VPC and associated subnets in GCP. Create and configure networking and load balancers in GCP. Create control plane and compute roles. Create the bootstrap machine. Create the control plane machines. Procedure Copy the template from the Deployment Manager template for worker machines section of this topic and save it as 06_worker.py on your computer. This template describes the worker machines that your cluster requires. Export the variables that the resource definition uses. Export the subnet that hosts the compute machines: USD export COMPUTE_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-worker-subnet --region=USD{REGION} --format json | jq -r .selfLink`) Export the email address for your service account: USD export WORKER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter "email~^USD{INFRA_ID}-w@USD{PROJECT_NAME}." --format json | jq -r '.[0].email'`) Export the location of the compute machine Ignition config file: USD export WORKER_IGNITION=`cat <installation_directory>/worker.ign` Create a 06_worker.yaml resource definition file: USD cat <<EOF >06_worker.yaml imports: - path: 06_worker.py resources: - name: 'worker-0' 1 type: 06_worker.py properties: infra_id: 'USD{INFRA_ID}' 2 zone: 'USD{ZONE_0}' 3 compute_subnet: 'USD{COMPUTE_SUBNET}' 4 image: 'USD{CLUSTER_IMAGE}' 5 machine_type: 'n1-standard-4' 6 root_volume_size: '128' service_account_email: 'USD{WORKER_SERVICE_ACCOUNT}' 7 ignition: 'USD{WORKER_IGNITION}' 8 - name: 'worker-1' type: 06_worker.py properties: infra_id: 'USD{INFRA_ID}' 9 zone: 'USD{ZONE_1}' 10 compute_subnet: 'USD{COMPUTE_SUBNET}' 11 image: 'USD{CLUSTER_IMAGE}' 12 machine_type: 'n1-standard-4' 13 root_volume_size: '128' service_account_email: 'USD{WORKER_SERVICE_ACCOUNT}' 14 ignition: 'USD{WORKER_IGNITION}' 15 EOF 1 name is the name of the worker machine, for example worker-0 . 2 9 infra_id is the INFRA_ID infrastructure name from the extraction step. 3 10 zone is the zone to deploy the worker machine into, for example us-central1-a . 4 11 compute_subnet is the selfLink URL to the compute subnet. 5 12 image is the selfLink URL to the RHCOS image. 1 6 13 machine_type is the machine type of the instance, for example n1-standard-4 . 7 14 service_account_email is the email address for the worker service account that you created. 8 15 ignition is the contents of the worker.ign file. Optional: If you want to launch additional instances, include additional resources of type 06_worker.py in your 06_worker.yaml resource definition file. Create the deployment by using the gcloud CLI: USD gcloud deployment-manager deployments create USD{INFRA_ID}-worker --config 06_worker.yaml To use a GCP Marketplace image, specify the offer to use: OpenShift Container Platform: https://www.googleapis.com/compute/v1/projects/redhat-marketplace-public/global/images/redhat-coreos-ocp-413-x86-64-202305021736 OpenShift Platform Plus: https://www.googleapis.com/compute/v1/projects/redhat-marketplace-public/global/images/redhat-coreos-opp-413-x86-64-202305021736 OpenShift Kubernetes Engine: https://www.googleapis.com/compute/v1/projects/redhat-marketplace-public/global/images/redhat-coreos-oke-413-x86-64-202305021736 13.18.1. Deployment Manager template for worker machines You can use the following Deployment Manager template to deploy the worker machines that you need for your OpenShift Container Platform cluster: Example 13.32. 06_worker.py Deployment Manager template def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-' + context.env['name'], 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zone'] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['compute_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-worker', ] }, 'zone': context.properties['zone'] } }] return {'resources': resources} 13.19. Logging in to the cluster by using the CLI You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OpenShift Container Platform installation. Prerequisites You deployed an OpenShift Container Platform cluster. You installed the oc CLI. Procedure Export the kubeadmin credentials: USD export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Verify you can run oc commands successfully using the exported configuration: USD oc whoami Example output system:admin 13.20. Disabling the default OperatorHub catalog sources Operator catalogs that source content provided by Red Hat and community projects are configured for OperatorHub by default during an OpenShift Container Platform installation. In a restricted network environment, you must disable the default catalogs as a cluster administrator. Procedure Disable the sources for the default catalogs by adding disableAllDefaultSources: true to the OperatorHub object: USD oc patch OperatorHub cluster --type json \ -p '[{"op": "add", "path": "/spec/disableAllDefaultSources", "value": true}]' Tip Alternatively, you can use the web console to manage catalog sources. From the Administration Cluster Settings Configuration OperatorHub page, click the Sources tab, where you can create, update, delete, disable, and enable individual sources. 13.21. Approving the certificate signing requests for your machines When you add machines to a cluster, two pending certificate signing requests (CSRs) are generated for each machine that you added. You must confirm that these CSRs are approved or, if necessary, approve them yourself. The client requests must be approved first, followed by the server requests. Prerequisites You added machines to your cluster. Procedure Confirm that the cluster recognizes the machines: USD oc get nodes Example output NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0 The output lists all of the machines that you created. Note The preceding output might not include the compute nodes, also known as worker nodes, until some CSRs are approved. Review the pending CSRs and ensure that you see the client requests with the Pending or Approved status for each machine that you added to the cluster: USD oc get csr Example output NAME AGE REQUESTOR CONDITION csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending ... In this example, two machines are joining the cluster. You might see more approved CSRs in the list. If the CSRs were not approved, after all of the pending CSRs for the machines you added are in Pending status, approve the CSRs for your cluster machines: Note Because the CSRs rotate automatically, approve your CSRs within an hour of adding the machines to the cluster. If you do not approve them within an hour, the certificates will rotate, and more than two certificates will be present for each node. You must approve all of these certificates. After the client CSR is approved, the Kubelet creates a secondary CSR for the serving certificate, which requires manual approval. Then, subsequent serving certificate renewal requests are automatically approved by the machine-approver if the Kubelet requests a new certificate with identical parameters. Note For clusters running on platforms that are not machine API enabled, such as bare metal and other user-provisioned infrastructure, you must implement a method of automatically approving the kubelet serving certificate requests (CSRs). If a request is not approved, then the oc exec , oc rsh , and oc logs commands cannot succeed, because a serving certificate is required when the API server connects to the kubelet. Any operation that contacts the Kubelet endpoint requires this certificate approval to be in place. The method must watch for new CSRs, confirm that the CSR was submitted by the node-bootstrapper service account in the system:node or system:admin groups, and confirm the identity of the node. To approve them individually, run the following command for each valid CSR: USD oc adm certificate approve <csr_name> 1 1 <csr_name> is the name of a CSR from the list of current CSRs. To approve all pending CSRs, run the following command: USD oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve Note Some Operators might not become available until some CSRs are approved. Now that your client requests are approved, you must review the server requests for each machine that you added to the cluster: USD oc get csr Example output NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending ... If the remaining CSRs are not approved, and are in the Pending status, approve the CSRs for your cluster machines: To approve them individually, run the following command for each valid CSR: USD oc adm certificate approve <csr_name> 1 1 <csr_name> is the name of a CSR from the list of current CSRs. To approve all pending CSRs, run the following command: USD oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs oc adm certificate approve After all client and server CSRs have been approved, the machines have the Ready status. Verify this by running the following command: USD oc get nodes Example output NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0 Note It can take a few minutes after approval of the server CSRs for the machines to transition to the Ready status. Additional information For more information on CSRs, see Certificate Signing Requests . 13.22. Optional: Adding the ingress DNS records If you removed the DNS zone configuration when creating Kubernetes manifests and generating Ignition configs, you must manually create DNS records that point at the ingress load balancer. You can create either a wildcard *.apps.{baseDomain}. or specific records. You can use A, CNAME, and other records per your requirements. Prerequisites Configure a GCP account. Remove the DNS Zone configuration when creating Kubernetes manifests and generating Ignition configs. Create and configure a VPC and associated subnets in GCP. Create and configure networking and load balancers in GCP. Create control plane and compute roles. Create the bootstrap machine. Create the control plane machines. Create the worker machines. Procedure Wait for the Ingress router to create a load balancer and populate the EXTERNAL-IP field: USD oc -n openshift-ingress get service router-default Example output NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE router-default LoadBalancer 172.30.18.154 35.233.157.184 80:32288/TCP,443:31215/TCP 98 Add the A record to your zones: To use A records: Export the variable for the router IP address: USD export ROUTER_IP=`oc -n openshift-ingress get service router-default --no-headers | awk '{print USD4}'` Add the A record to the private zones: USD if [ -f transaction.yaml ]; then rm transaction.yaml; fi USD gcloud dns record-sets transaction start --zone USD{INFRA_ID}-private-zone USD gcloud dns record-sets transaction add USD{ROUTER_IP} --name \*.apps.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 300 --type A --zone USD{INFRA_ID}-private-zone USD gcloud dns record-sets transaction execute --zone USD{INFRA_ID}-private-zone For an external cluster, also add the A record to the public zones: USD if [ -f transaction.yaml ]; then rm transaction.yaml; fi USD gcloud dns record-sets transaction start --zone USD{BASE_DOMAIN_ZONE_NAME} USD gcloud dns record-sets transaction add USD{ROUTER_IP} --name \*.apps.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 300 --type A --zone USD{BASE_DOMAIN_ZONE_NAME} USD gcloud dns record-sets transaction execute --zone USD{BASE_DOMAIN_ZONE_NAME} To add explicit domains instead of using a wildcard, create entries for each of the cluster's current routes: USD oc get --all-namespaces -o jsonpath='{range .items[*]}{range .status.ingress[*]}{.host}{"\n"}{end}{end}' routes Example output oauth-openshift.apps.your.cluster.domain.example.com console-openshift-console.apps.your.cluster.domain.example.com downloads-openshift-console.apps.your.cluster.domain.example.com alertmanager-main-openshift-monitoring.apps.your.cluster.domain.example.com prometheus-k8s-openshift-monitoring.apps.your.cluster.domain.example.com 13.23. Completing a GCP installation on user-provisioned infrastructure After you start the OpenShift Container Platform installation on Google Cloud Platform (GCP) user-provisioned infrastructure, you can monitor the cluster events until the cluster is ready. Prerequisites Deploy the bootstrap machine for an OpenShift Container Platform cluster on user-provisioned GCP infrastructure. Install the oc CLI and log in. Procedure Complete the cluster installation: USD ./openshift-install --dir <installation_directory> wait-for install-complete 1 Example output INFO Waiting up to 30m0s for the cluster to initialize... 1 For <installation_directory> , specify the path to the directory that you stored the installation files in. Important The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending node-bootstrapper certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. Observe the running state of your cluster. Run the following command to view the current cluster version and status: USD oc get clusterversion Example output NAME VERSION AVAILABLE PROGRESSING SINCE STATUS version False True 24m Working towards 4.5.4: 99% complete Run the following command to view the Operators managed on the control plane by the Cluster Version Operator (CVO): USD oc get clusteroperators Example output NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.5.4 True False False 7m56s cloud-credential 4.5.4 True False False 31m cluster-autoscaler 4.5.4 True False False 16m console 4.5.4 True False False 10m csi-snapshot-controller 4.5.4 True False False 16m dns 4.5.4 True False False 22m etcd 4.5.4 False False False 25s image-registry 4.5.4 True False False 16m ingress 4.5.4 True False False 16m insights 4.5.4 True False False 17m kube-apiserver 4.5.4 True False False 19m kube-controller-manager 4.5.4 True False False 20m kube-scheduler 4.5.4 True False False 20m kube-storage-version-migrator 4.5.4 True False False 16m machine-api 4.5.4 True False False 22m machine-config 4.5.4 True False False 22m marketplace 4.5.4 True False False 16m monitoring 4.5.4 True False False 10m network 4.5.4 True False False 23m node-tuning 4.5.4 True False False 23m openshift-apiserver 4.5.4 True False False 17m openshift-controller-manager 4.5.4 True False False 15m openshift-samples 4.5.4 True False False 16m operator-lifecycle-manager 4.5.4 True False False 22m operator-lifecycle-manager-catalog 4.5.4 True False False 22m operator-lifecycle-manager-packageserver 4.5.4 True False False 18m service-ca 4.5.4 True False False 23m service-catalog-apiserver 4.5.4 True False False 23m service-catalog-controller-manager 4.5.4 True False False 23m storage 4.5.4 True False False 17m Run the following command to view your cluster pods: USD oc get pods --all-namespaces Example output NAMESPACE NAME READY STATUS RESTARTS AGE kube-system etcd-member-ip-10-0-3-111.us-east-2.compute.internal 1/1 Running 0 35m kube-system etcd-member-ip-10-0-3-239.us-east-2.compute.internal 1/1 Running 0 37m kube-system etcd-member-ip-10-0-3-24.us-east-2.compute.internal 1/1 Running 0 35m openshift-apiserver-operator openshift-apiserver-operator-6d6674f4f4-h7t2t 1/1 Running 1 37m openshift-apiserver apiserver-fm48r 1/1 Running 0 30m openshift-apiserver apiserver-fxkvv 1/1 Running 0 29m openshift-apiserver apiserver-q85nm 1/1 Running 0 29m ... openshift-service-ca-operator openshift-service-ca-operator-66ff6dc6cd-9r257 1/1 Running 0 37m openshift-service-ca apiservice-cabundle-injector-695b6bcbc-cl5hm 1/1 Running 0 35m openshift-service-ca configmap-cabundle-injector-8498544d7-25qn6 1/1 Running 0 35m openshift-service-ca service-serving-cert-signer-6445fc9c6-wqdqn 1/1 Running 0 35m openshift-service-catalog-apiserver-operator openshift-service-catalog-apiserver-operator-549f44668b-b5q2w 1/1 Running 0 32m openshift-service-catalog-controller-manager-operator openshift-service-catalog-controller-manager-operator-b78cr2lnm 1/1 Running 0 31m When the current cluster version is AVAILABLE , the installation is complete. 13.24. Telemetry access for OpenShift Container Platform In OpenShift Container Platform 4.13, the Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to OpenShift Cluster Manager Hybrid Cloud Console . After you confirm that your OpenShift Cluster Manager Hybrid Cloud Console inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager, use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. Additional resources See About remote health monitoring for more information about the Telemetry service 13.25. steps Customize your cluster . Configure image streams for the Cluster Samples Operator and the must-gather tool. Learn how to use Operator Lifecycle Manager (OLM) on restricted networks . If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by configuring additional trust stores . If necessary, you can opt out of remote health reporting . If necessary, see Registering your disconnected cluster
[ "mkdir USDHOME/clusterconfig", "openshift-install create manifests --dir USDHOME/clusterconfig", "? SSH Public Key INFO Credentials loaded from the \"myprofile\" profile in file \"/home/myuser/.aws/credentials\" INFO Consuming Install Config from target directory INFO Manifests created in: USDHOME/clusterconfig/manifests and USDHOME/clusterconfig/openshift", "ls USDHOME/clusterconfig/openshift/", "99_kubeadmin-password-secret.yaml 99_openshift-cluster-api_master-machines-0.yaml 99_openshift-cluster-api_master-machines-1.yaml 99_openshift-cluster-api_master-machines-2.yaml", "variant: openshift version: 4.13.0 metadata: labels: machineconfiguration.openshift.io/role: worker name: 98-var-partition storage: disks: - device: /dev/disk/by-id/<device_name> 1 partitions: - label: var start_mib: <partition_start_offset> 2 size_mib: <partition_size> 3 number: 5 filesystems: - device: /dev/disk/by-partlabel/var path: /var format: xfs mount_options: [defaults, prjquota] 4 with_mount_unit: true", "butane USDHOME/clusterconfig/98-var-partition.bu -o USDHOME/clusterconfig/openshift/98-var-partition.yaml", "openshift-install create ignition-configs --dir USDHOME/clusterconfig ls USDHOME/clusterconfig/ auth bootstrap.ign master.ign metadata.json worker.ign", "./openshift-install create install-config --dir <installation_directory> 1", "rm -rf ~/.powervs", "pullSecret: '{\"auths\":{\"<mirror_host_name>:5000\": {\"auth\": \"<credentials>\",\"email\": \"[email protected]\"}}}'", "additionalTrustBundle: | -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE-----", "network: <existing_vpc> controlPlaneSubnet: <control_plane_subnet> computeSubnet: <compute_subnet>", "imageContentSources: - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: quay.io/openshift-release-dev/ocp-release - mirrors: - <mirror_host_name>:5000/<repo_name>/release source: registry.redhat.io/ocp/release", "controlPlane: platform: gcp: secureBoot: Enabled", "compute: - platform: gcp: secureBoot: Enabled", "platform: gcp: defaultMachinePlatform: secureBoot: Enabled", "controlPlane: platform: gcp: confidentialCompute: Enabled 1 type: n2d-standard-8 2 onHostMaintenance: Terminate 3", "compute: - platform: gcp: confidentialCompute: Enabled type: n2d-standard-8 onHostMaintenance: Terminate", "platform: gcp: defaultMachinePlatform: confidentialCompute: Enabled type: n2d-standard-8 onHostMaintenance: Terminate", "apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> 1 httpsProxy: https://<username>:<pswd>@<ip>:<port> 2 noProxy: example.com 3 additionalTrustBundle: | 4 -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> 5", "./openshift-install wait-for install-complete --log-level debug", "./openshift-install create manifests --dir <installation_directory> 1", "rm -f <installation_directory>/openshift/99_openshift-cluster-api_master-machines-*.yaml", "rm -f <installation_directory>/openshift/99_openshift-machine-api_master-control-plane-machine-set.yaml", "rm -f <installation_directory>/openshift/99_openshift-cluster-api_worker-machineset-*.yaml", "apiVersion: config.openshift.io/v1 kind: DNS metadata: creationTimestamp: null name: cluster spec: baseDomain: example.openshift.com privateZone: 1 id: mycluster-100419-private-zone publicZone: 2 id: example.openshift.com status: {}", "./openshift-install create ignition-configs --dir <installation_directory> 1", ". ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign", "jq -r .infraID <installation_directory>/metadata.json 1", "openshift-vw9j6 1", "export BASE_DOMAIN='<base_domain>' export BASE_DOMAIN_ZONE_NAME='<base_domain_zone_name>' export NETWORK_CIDR='10.0.0.0/16' export MASTER_SUBNET_CIDR='10.0.0.0/17' export WORKER_SUBNET_CIDR='10.0.128.0/17' export KUBECONFIG=<installation_directory>/auth/kubeconfig 1 export CLUSTER_NAME=`jq -r .clusterName <installation_directory>/metadata.json` export INFRA_ID=`jq -r .infraID <installation_directory>/metadata.json` export PROJECT_NAME=`jq -r .gcp.projectID <installation_directory>/metadata.json` export REGION=`jq -r .gcp.region <installation_directory>/metadata.json`", "cat <<EOF >01_vpc.yaml imports: - path: 01_vpc.py resources: - name: cluster-vpc type: 01_vpc.py properties: infra_id: 'USD{INFRA_ID}' 1 region: 'USD{REGION}' 2 master_subnet_cidr: 'USD{MASTER_SUBNET_CIDR}' 3 worker_subnet_cidr: 'USD{WORKER_SUBNET_CIDR}' 4 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-vpc --config 01_vpc.yaml", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-network', 'type': 'compute.v1.network', 'properties': { 'region': context.properties['region'], 'autoCreateSubnetworks': False } }, { 'name': context.properties['infra_id'] + '-master-subnet', 'type': 'compute.v1.subnetwork', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'ipCidrRange': context.properties['master_subnet_cidr'] } }, { 'name': context.properties['infra_id'] + '-worker-subnet', 'type': 'compute.v1.subnetwork', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'ipCidrRange': context.properties['worker_subnet_cidr'] } }, { 'name': context.properties['infra_id'] + '-router', 'type': 'compute.v1.router', 'properties': { 'region': context.properties['region'], 'network': 'USD(ref.' + context.properties['infra_id'] + '-network.selfLink)', 'nats': [{ 'name': context.properties['infra_id'] + '-nat-master', 'natIpAllocateOption': 'AUTO_ONLY', 'minPortsPerVm': 7168, 'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS', 'subnetworks': [{ 'name': 'USD(ref.' + context.properties['infra_id'] + '-master-subnet.selfLink)', 'sourceIpRangesToNat': ['ALL_IP_RANGES'] }] }, { 'name': context.properties['infra_id'] + '-nat-worker', 'natIpAllocateOption': 'AUTO_ONLY', 'minPortsPerVm': 512, 'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS', 'subnetworks': [{ 'name': 'USD(ref.' + context.properties['infra_id'] + '-worker-subnet.selfLink)', 'sourceIpRangesToNat': ['ALL_IP_RANGES'] }] }] } }] return {'resources': resources}", "export CLUSTER_NETWORK=(`gcloud compute networks describe USD{INFRA_ID}-network --format json | jq -r .selfLink`)", "export CONTROL_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-master-subnet --region=USD{REGION} --format json | jq -r .selfLink`)", "export ZONE_0=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[0] | cut -d \"/\" -f9`)", "export ZONE_1=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[1] | cut -d \"/\" -f9`)", "export ZONE_2=(`gcloud compute regions describe USD{REGION} --format=json | jq -r .zones[2] | cut -d \"/\" -f9`)", "cat <<EOF >02_infra.yaml imports: - path: 02_lb_ext.py - path: 02_lb_int.py 1 resources: - name: cluster-lb-ext 2 type: 02_lb_ext.py properties: infra_id: 'USD{INFRA_ID}' 3 region: 'USD{REGION}' 4 - name: cluster-lb-int type: 02_lb_int.py properties: cluster_network: 'USD{CLUSTER_NETWORK}' control_subnet: 'USD{CONTROL_SUBNET}' 5 infra_id: 'USD{INFRA_ID}' region: 'USD{REGION}' zones: 6 - 'USD{ZONE_0}' - 'USD{ZONE_1}' - 'USD{ZONE_2}' EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-infra --config 02_infra.yaml", "export CLUSTER_IP=(`gcloud compute addresses describe USD{INFRA_ID}-cluster-ip --region=USD{REGION} --format json | jq -r .address`)", "export CLUSTER_PUBLIC_IP=(`gcloud compute addresses describe USD{INFRA_ID}-cluster-public-ip --region=USD{REGION} --format json | jq -r .address`)", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-cluster-public-ip', 'type': 'compute.v1.address', 'properties': { 'region': context.properties['region'] } }, { # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver 'name': context.properties['infra_id'] + '-api-http-health-check', 'type': 'compute.v1.httpHealthCheck', 'properties': { 'port': 6080, 'requestPath': '/readyz' } }, { 'name': context.properties['infra_id'] + '-api-target-pool', 'type': 'compute.v1.targetPool', 'properties': { 'region': context.properties['region'], 'healthChecks': ['USD(ref.' + context.properties['infra_id'] + '-api-http-health-check.selfLink)'], 'instances': [] } }, { 'name': context.properties['infra_id'] + '-api-forwarding-rule', 'type': 'compute.v1.forwardingRule', 'properties': { 'region': context.properties['region'], 'IPAddress': 'USD(ref.' + context.properties['infra_id'] + '-cluster-public-ip.selfLink)', 'target': 'USD(ref.' + context.properties['infra_id'] + '-api-target-pool.selfLink)', 'portRange': '6443' } }] return {'resources': resources}", "def GenerateConfig(context): backends = [] for zone in context.properties['zones']: backends.append({ 'group': 'USD(ref.' + context.properties['infra_id'] + '-master-' + zone + '-ig' + '.selfLink)' }) resources = [{ 'name': context.properties['infra_id'] + '-cluster-ip', 'type': 'compute.v1.address', 'properties': { 'addressType': 'INTERNAL', 'region': context.properties['region'], 'subnetwork': context.properties['control_subnet'] } }, { # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver 'name': context.properties['infra_id'] + '-api-internal-health-check', 'type': 'compute.v1.healthCheck', 'properties': { 'httpsHealthCheck': { 'port': 6443, 'requestPath': '/readyz' }, 'type': \"HTTPS\" } }, { 'name': context.properties['infra_id'] + '-api-internal-backend-service', 'type': 'compute.v1.regionBackendService', 'properties': { 'backends': backends, 'healthChecks': ['USD(ref.' + context.properties['infra_id'] + '-api-internal-health-check.selfLink)'], 'loadBalancingScheme': 'INTERNAL', 'region': context.properties['region'], 'protocol': 'TCP', 'timeoutSec': 120 } }, { 'name': context.properties['infra_id'] + '-api-internal-forwarding-rule', 'type': 'compute.v1.forwardingRule', 'properties': { 'backendService': 'USD(ref.' + context.properties['infra_id'] + '-api-internal-backend-service.selfLink)', 'IPAddress': 'USD(ref.' + context.properties['infra_id'] + '-cluster-ip.selfLink)', 'loadBalancingScheme': 'INTERNAL', 'ports': ['6443','22623'], 'region': context.properties['region'], 'subnetwork': context.properties['control_subnet'] } }] for zone in context.properties['zones']: resources.append({ 'name': context.properties['infra_id'] + '-master-' + zone + '-ig', 'type': 'compute.v1.instanceGroup', 'properties': { 'namedPorts': [ { 'name': 'ignition', 'port': 22623 }, { 'name': 'https', 'port': 6443 } ], 'network': context.properties['cluster_network'], 'zone': zone } }) return {'resources': resources}", "cat <<EOF >02_dns.yaml imports: - path: 02_dns.py resources: - name: cluster-dns type: 02_dns.py properties: infra_id: 'USD{INFRA_ID}' 1 cluster_domain: 'USD{CLUSTER_NAME}.USD{BASE_DOMAIN}' 2 cluster_network: 'USD{CLUSTER_NETWORK}' 3 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-dns --config 02_dns.yaml", "if [ -f transaction.yaml ]; then rm transaction.yaml; fi gcloud dns record-sets transaction start --zone USD{INFRA_ID}-private-zone gcloud dns record-sets transaction add USD{CLUSTER_IP} --name api.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{INFRA_ID}-private-zone gcloud dns record-sets transaction add USD{CLUSTER_IP} --name api-int.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{INFRA_ID}-private-zone gcloud dns record-sets transaction execute --zone USD{INFRA_ID}-private-zone", "if [ -f transaction.yaml ]; then rm transaction.yaml; fi gcloud dns record-sets transaction start --zone USD{BASE_DOMAIN_ZONE_NAME} gcloud dns record-sets transaction add USD{CLUSTER_PUBLIC_IP} --name api.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 60 --type A --zone USD{BASE_DOMAIN_ZONE_NAME} gcloud dns record-sets transaction execute --zone USD{BASE_DOMAIN_ZONE_NAME}", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-private-zone', 'type': 'dns.v1.managedZone', 'properties': { 'description': '', 'dnsName': context.properties['cluster_domain'] + '.', 'visibility': 'private', 'privateVisibilityConfig': { 'networks': [{ 'networkUrl': context.properties['cluster_network'] }] } } }] return {'resources': resources}", "cat <<EOF >03_firewall.yaml imports: - path: 03_firewall.py resources: - name: cluster-firewall type: 03_firewall.py properties: allowed_external_cidr: '0.0.0.0/0' 1 infra_id: 'USD{INFRA_ID}' 2 cluster_network: 'USD{CLUSTER_NETWORK}' 3 network_cidr: 'USD{NETWORK_CIDR}' 4 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-firewall --config 03_firewall.yaml", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-bootstrap-in-ssh', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['22'] }], 'sourceRanges': [context.properties['allowed_external_cidr']], 'targetTags': [context.properties['infra_id'] + '-bootstrap'] } }, { 'name': context.properties['infra_id'] + '-api', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['6443'] }], 'sourceRanges': [context.properties['allowed_external_cidr']], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-health-checks', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['6080', '6443', '22624'] }], 'sourceRanges': ['35.191.0.0/16', '130.211.0.0/22', '209.85.152.0/22', '209.85.204.0/22'], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-etcd', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['2379-2380'] }], 'sourceTags': [context.properties['infra_id'] + '-master'], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-control-plane', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'tcp', 'ports': ['10257'] },{ 'IPProtocol': 'tcp', 'ports': ['10259'] },{ 'IPProtocol': 'tcp', 'ports': ['22623'] }], 'sourceTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ], 'targetTags': [context.properties['infra_id'] + '-master'] } }, { 'name': context.properties['infra_id'] + '-internal-network', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'icmp' },{ 'IPProtocol': 'tcp', 'ports': ['22'] }], 'sourceRanges': [context.properties['network_cidr']], 'targetTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ] } }, { 'name': context.properties['infra_id'] + '-internal-cluster', 'type': 'compute.v1.firewall', 'properties': { 'network': context.properties['cluster_network'], 'allowed': [{ 'IPProtocol': 'udp', 'ports': ['4789', '6081'] },{ 'IPProtocol': 'udp', 'ports': ['500', '4500'] },{ 'IPProtocol': 'esp', },{ 'IPProtocol': 'tcp', 'ports': ['9000-9999'] },{ 'IPProtocol': 'udp', 'ports': ['9000-9999'] },{ 'IPProtocol': 'tcp', 'ports': ['10250'] },{ 'IPProtocol': 'tcp', 'ports': ['30000-32767'] },{ 'IPProtocol': 'udp', 'ports': ['30000-32767'] }], 'sourceTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ], 'targetTags': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-worker' ] } }] return {'resources': resources}", "cat <<EOF >03_iam.yaml imports: - path: 03_iam.py resources: - name: cluster-iam type: 03_iam.py properties: infra_id: 'USD{INFRA_ID}' 1 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-iam --config 03_iam.yaml", "export MASTER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter \"email~^USD{INFRA_ID}-m@USD{PROJECT_NAME}.\" --format json | jq -r '.[0].email'`)", "export WORKER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter \"email~^USD{INFRA_ID}-w@USD{PROJECT_NAME}.\" --format json | jq -r '.[0].email'`)", "export COMPUTE_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-worker-subnet --region=USD{REGION} --format json | jq -r .selfLink`)", "gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{MASTER_SERVICE_ACCOUNT}\" --role \"roles/compute.instanceAdmin\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{MASTER_SERVICE_ACCOUNT}\" --role \"roles/compute.networkAdmin\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{MASTER_SERVICE_ACCOUNT}\" --role \"roles/compute.securityAdmin\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{MASTER_SERVICE_ACCOUNT}\" --role \"roles/iam.serviceAccountUser\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{MASTER_SERVICE_ACCOUNT}\" --role \"roles/storage.admin\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{WORKER_SERVICE_ACCOUNT}\" --role \"roles/compute.viewer\" gcloud projects add-iam-policy-binding USD{PROJECT_NAME} --member \"serviceAccount:USD{WORKER_SERVICE_ACCOUNT}\" --role \"roles/storage.admin\"", "gcloud iam service-accounts keys create service-account-key.json --iam-account=USD{MASTER_SERVICE_ACCOUNT}", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-master-node-sa', 'type': 'iam.v1.serviceAccount', 'properties': { 'accountId': context.properties['infra_id'] + '-m', 'displayName': context.properties['infra_id'] + '-master-node' } }, { 'name': context.properties['infra_id'] + '-worker-node-sa', 'type': 'iam.v1.serviceAccount', 'properties': { 'accountId': context.properties['infra_id'] + '-w', 'displayName': context.properties['infra_id'] + '-worker-node' } }] return {'resources': resources}", "gsutil mb gs://<bucket_name>", "gsutil cp <downloaded_image_file_path>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz gs://<bucket_name>", "export IMAGE_SOURCE=gs://<bucket_name>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz", "gcloud compute images create \"USD{INFRA_ID}-rhcos-image\" --source-uri=\"USD{IMAGE_SOURCE}\"", "export CLUSTER_IMAGE=(`gcloud compute images describe USD{INFRA_ID}-rhcos-image --format json | jq -r .selfLink`)", "gsutil mb gs://USD{INFRA_ID}-bootstrap-ignition", "gsutil cp <installation_directory>/bootstrap.ign gs://USD{INFRA_ID}-bootstrap-ignition/", "export BOOTSTRAP_IGN=`gsutil signurl -d 1h service-account-key.json gs://USD{INFRA_ID}-bootstrap-ignition/bootstrap.ign | grep \"^gs:\" | awk '{print USD5}'`", "cat <<EOF >04_bootstrap.yaml imports: - path: 04_bootstrap.py resources: - name: cluster-bootstrap type: 04_bootstrap.py properties: infra_id: 'USD{INFRA_ID}' 1 region: 'USD{REGION}' 2 zone: 'USD{ZONE_0}' 3 cluster_network: 'USD{CLUSTER_NETWORK}' 4 control_subnet: 'USD{CONTROL_SUBNET}' 5 image: 'USD{CLUSTER_IMAGE}' 6 machine_type: 'n1-standard-4' 7 root_volume_size: '128' 8 bootstrap_ign: 'USD{BOOTSTRAP_IGN}' 9 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-bootstrap --config 04_bootstrap.yaml", "gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-bootstrap-ig --zone=USD{ZONE_0} --instances=USD{INFRA_ID}-bootstrap", "gcloud compute backend-services add-backend USD{INFRA_ID}-api-internal-backend-service --region=USD{REGION} --instance-group=USD{INFRA_ID}-bootstrap-ig --instance-group-zone=USD{ZONE_0}", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-bootstrap-public-ip', 'type': 'compute.v1.address', 'properties': { 'region': context.properties['region'] } }, { 'name': context.properties['infra_id'] + '-bootstrap', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zone'] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': '{\"ignition\":{\"config\":{\"replace\":{\"source\":\"' + context.properties['bootstrap_ign'] + '\"}},\"version\":\"3.2.0\"}}', }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'], 'accessConfigs': [{ 'natIP': 'USD(ref.' + context.properties['infra_id'] + '-bootstrap-public-ip.address)' }] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', context.properties['infra_id'] + '-bootstrap' ] }, 'zone': context.properties['zone'] } }, { 'name': context.properties['infra_id'] + '-bootstrap-ig', 'type': 'compute.v1.instanceGroup', 'properties': { 'namedPorts': [ { 'name': 'ignition', 'port': 22623 }, { 'name': 'https', 'port': 6443 } ], 'network': context.properties['cluster_network'], 'zone': context.properties['zone'] } }] return {'resources': resources}", "export MASTER_IGNITION=`cat <installation_directory>/master.ign`", "cat <<EOF >05_control_plane.yaml imports: - path: 05_control_plane.py resources: - name: cluster-control-plane type: 05_control_plane.py properties: infra_id: 'USD{INFRA_ID}' 1 zones: 2 - 'USD{ZONE_0}' - 'USD{ZONE_1}' - 'USD{ZONE_2}' control_subnet: 'USD{CONTROL_SUBNET}' 3 image: 'USD{CLUSTER_IMAGE}' 4 machine_type: 'n1-standard-4' 5 root_volume_size: '128' service_account_email: 'USD{MASTER_SERVICE_ACCOUNT}' 6 ignition: 'USD{MASTER_IGNITION}' 7 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-control-plane --config 05_control_plane.yaml", "gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_0}-ig --zone=USD{ZONE_0} --instances=USD{INFRA_ID}-master-0", "gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_1}-ig --zone=USD{ZONE_1} --instances=USD{INFRA_ID}-master-1", "gcloud compute instance-groups unmanaged add-instances USD{INFRA_ID}-master-USD{ZONE_2}-ig --zone=USD{ZONE_2} --instances=USD{INFRA_ID}-master-2", "gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone=\"USD{ZONE_0}\" --instances=USD{INFRA_ID}-master-0", "gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone=\"USD{ZONE_1}\" --instances=USD{INFRA_ID}-master-1", "gcloud compute target-pools add-instances USD{INFRA_ID}-api-target-pool --instances-zone=\"USD{ZONE_2}\" --instances=USD{INFRA_ID}-master-2", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-master-0', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][0] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][0] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][0] } }, { 'name': context.properties['infra_id'] + '-master-1', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][1] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][1] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][1] } }, { 'name': context.properties['infra_id'] + '-master-2', 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'diskType': 'zones/' + context.properties['zones'][2] + '/diskTypes/pd-ssd', 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zones'][2] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['control_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-master', ] }, 'zone': context.properties['zones'][2] } }] return {'resources': resources}", "./openshift-install wait-for bootstrap-complete --dir <installation_directory> \\ 1 --log-level info 2", "gcloud compute backend-services remove-backend USD{INFRA_ID}-api-internal-backend-service --region=USD{REGION} --instance-group=USD{INFRA_ID}-bootstrap-ig --instance-group-zone=USD{ZONE_0}", "gsutil rm gs://USD{INFRA_ID}-bootstrap-ignition/bootstrap.ign", "gsutil rb gs://USD{INFRA_ID}-bootstrap-ignition", "gcloud deployment-manager deployments delete USD{INFRA_ID}-bootstrap", "export COMPUTE_SUBNET=(`gcloud compute networks subnets describe USD{INFRA_ID}-worker-subnet --region=USD{REGION} --format json | jq -r .selfLink`)", "export WORKER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter \"email~^USD{INFRA_ID}-w@USD{PROJECT_NAME}.\" --format json | jq -r '.[0].email'`)", "export WORKER_IGNITION=`cat <installation_directory>/worker.ign`", "cat <<EOF >06_worker.yaml imports: - path: 06_worker.py resources: - name: 'worker-0' 1 type: 06_worker.py properties: infra_id: 'USD{INFRA_ID}' 2 zone: 'USD{ZONE_0}' 3 compute_subnet: 'USD{COMPUTE_SUBNET}' 4 image: 'USD{CLUSTER_IMAGE}' 5 machine_type: 'n1-standard-4' 6 root_volume_size: '128' service_account_email: 'USD{WORKER_SERVICE_ACCOUNT}' 7 ignition: 'USD{WORKER_IGNITION}' 8 - name: 'worker-1' type: 06_worker.py properties: infra_id: 'USD{INFRA_ID}' 9 zone: 'USD{ZONE_1}' 10 compute_subnet: 'USD{COMPUTE_SUBNET}' 11 image: 'USD{CLUSTER_IMAGE}' 12 machine_type: 'n1-standard-4' 13 root_volume_size: '128' service_account_email: 'USD{WORKER_SERVICE_ACCOUNT}' 14 ignition: 'USD{WORKER_IGNITION}' 15 EOF", "gcloud deployment-manager deployments create USD{INFRA_ID}-worker --config 06_worker.yaml", "def GenerateConfig(context): resources = [{ 'name': context.properties['infra_id'] + '-' + context.env['name'], 'type': 'compute.v1.instance', 'properties': { 'disks': [{ 'autoDelete': True, 'boot': True, 'initializeParams': { 'diskSizeGb': context.properties['root_volume_size'], 'sourceImage': context.properties['image'] } }], 'machineType': 'zones/' + context.properties['zone'] + '/machineTypes/' + context.properties['machine_type'], 'metadata': { 'items': [{ 'key': 'user-data', 'value': context.properties['ignition'] }] }, 'networkInterfaces': [{ 'subnetwork': context.properties['compute_subnet'] }], 'serviceAccounts': [{ 'email': context.properties['service_account_email'], 'scopes': ['https://www.googleapis.com/auth/cloud-platform'] }], 'tags': { 'items': [ context.properties['infra_id'] + '-worker', ] }, 'zone': context.properties['zone'] } }] return {'resources': resources}", "export KUBECONFIG=<installation_directory>/auth/kubeconfig 1", "oc whoami", "system:admin", "oc patch OperatorHub cluster --type json -p '[{\"op\": \"add\", \"path\": \"/spec/disableAllDefaultSources\", \"value\": true}]'", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.26.0 master-1 Ready master 63m v1.26.0 master-2 Ready master 64m v1.26.0", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve", "oc get csr", "NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending", "oc adm certificate approve <csr_name> 1", "oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{\"\\n\"}}{{end}}{{end}}' | xargs oc adm certificate approve", "oc get nodes", "NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.26.0 master-1 Ready master 73m v1.26.0 master-2 Ready master 74m v1.26.0 worker-0 Ready worker 11m v1.26.0 worker-1 Ready worker 11m v1.26.0", "oc -n openshift-ingress get service router-default", "NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE router-default LoadBalancer 172.30.18.154 35.233.157.184 80:32288/TCP,443:31215/TCP 98", "export ROUTER_IP=`oc -n openshift-ingress get service router-default --no-headers | awk '{print USD4}'`", "if [ -f transaction.yaml ]; then rm transaction.yaml; fi gcloud dns record-sets transaction start --zone USD{INFRA_ID}-private-zone gcloud dns record-sets transaction add USD{ROUTER_IP} --name \\*.apps.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 300 --type A --zone USD{INFRA_ID}-private-zone gcloud dns record-sets transaction execute --zone USD{INFRA_ID}-private-zone", "if [ -f transaction.yaml ]; then rm transaction.yaml; fi gcloud dns record-sets transaction start --zone USD{BASE_DOMAIN_ZONE_NAME} gcloud dns record-sets transaction add USD{ROUTER_IP} --name \\*.apps.USD{CLUSTER_NAME}.USD{BASE_DOMAIN}. --ttl 300 --type A --zone USD{BASE_DOMAIN_ZONE_NAME} gcloud dns record-sets transaction execute --zone USD{BASE_DOMAIN_ZONE_NAME}", "oc get --all-namespaces -o jsonpath='{range .items[*]}{range .status.ingress[*]}{.host}{\"\\n\"}{end}{end}' routes", "oauth-openshift.apps.your.cluster.domain.example.com console-openshift-console.apps.your.cluster.domain.example.com downloads-openshift-console.apps.your.cluster.domain.example.com alertmanager-main-openshift-monitoring.apps.your.cluster.domain.example.com prometheus-k8s-openshift-monitoring.apps.your.cluster.domain.example.com", "./openshift-install --dir <installation_directory> wait-for install-complete 1", "INFO Waiting up to 30m0s for the cluster to initialize", "oc get clusterversion", "NAME VERSION AVAILABLE PROGRESSING SINCE STATUS version False True 24m Working towards 4.5.4: 99% complete", "oc get clusteroperators", "NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.5.4 True False False 7m56s cloud-credential 4.5.4 True False False 31m cluster-autoscaler 4.5.4 True False False 16m console 4.5.4 True False False 10m csi-snapshot-controller 4.5.4 True False False 16m dns 4.5.4 True False False 22m etcd 4.5.4 False False False 25s image-registry 4.5.4 True False False 16m ingress 4.5.4 True False False 16m insights 4.5.4 True False False 17m kube-apiserver 4.5.4 True False False 19m kube-controller-manager 4.5.4 True False False 20m kube-scheduler 4.5.4 True False False 20m kube-storage-version-migrator 4.5.4 True False False 16m machine-api 4.5.4 True False False 22m machine-config 4.5.4 True False False 22m marketplace 4.5.4 True False False 16m monitoring 4.5.4 True False False 10m network 4.5.4 True False False 23m node-tuning 4.5.4 True False False 23m openshift-apiserver 4.5.4 True False False 17m openshift-controller-manager 4.5.4 True False False 15m openshift-samples 4.5.4 True False False 16m operator-lifecycle-manager 4.5.4 True False False 22m operator-lifecycle-manager-catalog 4.5.4 True False False 22m operator-lifecycle-manager-packageserver 4.5.4 True False False 18m service-ca 4.5.4 True False False 23m service-catalog-apiserver 4.5.4 True False False 23m service-catalog-controller-manager 4.5.4 True False False 23m storage 4.5.4 True False False 17m", "oc get pods --all-namespaces", "NAMESPACE NAME READY STATUS RESTARTS AGE kube-system etcd-member-ip-10-0-3-111.us-east-2.compute.internal 1/1 Running 0 35m kube-system etcd-member-ip-10-0-3-239.us-east-2.compute.internal 1/1 Running 0 37m kube-system etcd-member-ip-10-0-3-24.us-east-2.compute.internal 1/1 Running 0 35m openshift-apiserver-operator openshift-apiserver-operator-6d6674f4f4-h7t2t 1/1 Running 1 37m openshift-apiserver apiserver-fm48r 1/1 Running 0 30m openshift-apiserver apiserver-fxkvv 1/1 Running 0 29m openshift-apiserver apiserver-q85nm 1/1 Running 0 29m openshift-service-ca-operator openshift-service-ca-operator-66ff6dc6cd-9r257 1/1 Running 0 37m openshift-service-ca apiservice-cabundle-injector-695b6bcbc-cl5hm 1/1 Running 0 35m openshift-service-ca configmap-cabundle-injector-8498544d7-25qn6 1/1 Running 0 35m openshift-service-ca service-serving-cert-signer-6445fc9c6-wqdqn 1/1 Running 0 35m openshift-service-catalog-apiserver-operator openshift-service-catalog-apiserver-operator-549f44668b-b5q2w 1/1 Running 0 32m openshift-service-catalog-controller-manager-operator openshift-service-catalog-controller-manager-operator-b78cr2lnm 1/1 Running 0 31m" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html/installing_on_gcp/installing-restricted-networks-gcp
Chapter 6. Uninstalling power monitoring
Chapter 6. Uninstalling power monitoring Important Power monitoring is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope . You can uninstall power monitoring by deleting the Kepler instance and then the Power monitoring Operator in the OpenShift Container Platform web console. 6.1. Deleting Kepler You can delete Kepler by removing the Kepler instance of the Kepler custom resource definition (CRD) from the OpenShift Container Platform web console. Prerequisites You have access to the OpenShift Container Platform web console. You are logged in as a user with the cluster-admin role. Procedure In the Administrator perspective of the web console, go to Operators Installed Operators . Click Power monitoring for Red Hat OpenShift from the Installed Operators list and go to the Kepler tab. Locate the Kepler instance entry in the list. Click for this entry and select Delete Kepler . In the Delete Kepler? dialog, click Delete to delete the Kepler instance. 6.2. Uninstalling the Power monitoring Operator If you installed the Power monitoring Operator by using OperatorHub, you can uninstall it from the OpenShift Container Platform web console. Prerequisites You have access to the OpenShift Container Platform web console. You are logged in as a user with the cluster-admin role. Procedure Delete the Kepler instance. Warning Ensure that you have deleted the Kepler instance before uninstalling the Power monitoring Operator. Go to Operators Installed Operators . Locate the Power monitoring for Red Hat OpenShift entry in the list. Click for this entry and select Uninstall Operator . In the Uninstall Operator? dialog, click Uninstall to uninstall the Power monitoring Operator.
null
https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/power_monitoring/uninstalling-power-monitoring
Chapter 1. 3scale API Management glossary
Chapter 1. 3scale API Management glossary This section acts as a glossary of common terms used within the 3scale platform. The following is the structure of glossary entries: A glossary term One or more of each or both of the following items: A definition of the term, optionally followed by one or two explanatory sentences and a See also reference that points to a related term or terms. Example: hit : The built-in metric to which all methods report. Additional top-level metrics can be added here in order to track other usage that should not increase the hit count. See also Section 1.14.4, "metric" . --- In this case, hit is related to metric because hit is a built-in metric. A See reference that points to a preferred synonym for that term or to the spelled-out version of an abbreviated term. Example: account : See Section 1.21.1, "tenant account" , Section 1.5.2, "developer account" . --- In this case, the reader is redirected from account to either of the relevant terms containing qualifiers. If there is more than one definition for a term, each item is numbered. 1.1. Special characters 1.1.1. [Your_admin_domain] Admin domain created by the user. 1.1.2. [Your_API_name] API created by the user. See also Section 1.2.22, "application programming interface" . 1.1.3. [Your_API_service] See Section 1.1.2, "[Your_API_name]" . 1.1.4. [Your_product_name] Product created by the user. See also Section 1.17.3, "product" . 1.1.5. 3scale API Management docs Based on Open API Specification (OAS), a 3scale specification for documenting REST APIs from Red Hat 3scale API Management. See also Section 1.2.2, "ActiveDocs" , Section 1.16.2, "OpenAPI Specification" . 1.1.6. 3scale API Management backend Part of the 3scale API Manager, along with System. 1.2. A 1.2.1. account See Section 1.21.1, "tenant account" , Section 1.5.2, "developer account" . 1.2.2. ActiveDocs Based on Open API Specification (OAS), a 3scale specification for documenting REST APIs created by users. APIs get interactive documentation which makes it easier for developers to understand APIs and also to test them without any installation. See also Section 1.1.5, "3scale API Management docs" , Section 1.16.2, "OpenAPI Specification" . 1.2.3. access token Personal token that allow users to authenticate against the Account Management API, the Analytics API and the Billing API through HTTP Basic Auth. Users can create multiple access tokens with custom scopes and permissions. See also Section 1.1.5, "3scale API Management docs" , Section 1.20.2, "service token" . 1.2.4. Admin Portal The central portal for API providers to manage and secure access to their Products. From this portal, API providers can configure the integration of their Product with 3scale, manage their application plans, give access to internal members and external customers, limit traffic per application keys, and customize their Developer Portal. See also Section 1.5.3, "Developer Portal" , Section 1.17.3, "product" . 1.2.5. Administration Portal See Section 1.2.4, "Admin Portal" . 1.2.6. API See Section 1.2.22, "application programming interface" . 1.2.7. APIsonator See Section 1.1.6, "3scale API Management backend" . 1.2.8. API backend Implementation of an API deployed in a host. See also Section 1.2.22, "application programming interface" , Section 1.3.1, "backend" . 1.2.9. API consumer An individual, group, or company that accesses an API or a product managed by the API provider. The term may refer both to the organization and the software applications written by the organizations to use the API. A given organization may have one or more applications which access the API. See also Section 1.2.12, "API provider" . 1.2.10. API credential See Section 1.2.13, "API key" , Section 1.23.1, "user key" . 1.2.11. API endpoint See Section 1.2.22, "application programming interface" , Section 1.14.3, "method" . 1.2.12. API provider The entity that owns the APIs and products, and gives access to them by using Red Hat 3scale API Management. An API provider may make their APIs accessible to other teams internally within their organization or externally to third-party developers, partners, or the public. It might include one or multiple tenants. See also Section 1.2.9, "API consumer" , Section 1.21.1, "tenant account" . 1.2.13. API key A type of credential for an application to be allowed to make calls on a specific API or product. API Keys are a specific type of authentication pattern. See also Section 1.2.22, "application programming interface" . 1.2.14. API manager See Section 1.2.4, "Admin Portal" . 1.2.15. API method See Section 1.14.3, "method" . 1.2.16. API product See Section 1.17.3, "product" . 1.2.17. APIcast An API gateway based on NGINX used to integrate internal and external APIs with Red Hat 3scale API Management. APIcast is the interface that handles API requests, and depending on its configuration it can handle access control, rate limiting, security filtering, logging, routing, caching, etc . See also Section 1.2.22, "application programming interface" , Section 1.17.3, "product" . 1.2.18. APIcast gateway See Section 1.2.17, "APIcast" . 1.2.19. app identifier Authentication method working with app identifier. See also Section 1.2.20, "app key" . 1.2.20. app key Authentication method with app keys. See also Section 1.2.19, "app identifier" . 1.2.21. application A piece of software code which is developed to perform some logic. The application will normally have associated to it within the 3scale system a unique set of credentials for the API, a traffic history of the calls sent to the API and meta-data captured at application creation. Applications are linked to developer accounts. See Section 1.2.9, "API consumer" . See also Section 1.5.2, "developer account" . 1.2.22. application programming interface An interface to a software component that can be invoked at a distance over a communications network using standards based technologies. A logical bundle of processes, functions, and methods offered by a programming library, as an abstraction layer, to be used by another computer program. See also Section 1.1.2, "[Your_API_name]" , Section 1.2.17, "APIcast" , Section 1.2.13, "API key" , Section 1.3.1, "backend" , Section 1.6.1, "endpoint" , Section 1.6.2, "end user" , Section 1.14.3, "method" , Section 1.17.3, "product" , Section 1.20.1, "service" . 1.2.23. authentication The process of verifying the identity of a user or server requesting access to an API or product. 1.3. B 1.3.1. backend In the context of API as a Product, one or more APIs bundled in a product. See also Section 1.3.2, "base URL" , Section 1.17.3, "product" . As an API, see also Section 1.2.8, "API backend" . As a 3scale component, see Section 1.1.6, "3scale API Management backend" . 1.3.2. base URL In the context of APIs as a Product, the private endpoint defined in the backend. See also Section 1.3.1, "backend" , Section 1.6.1, "endpoint" . The URL address defined in the Integration Settings for the API Gateway. These addresses are the Staging Public Base URL, and the Production Public Base URL. 1.4. C 1.4.1. client See Section 1.2.9, "API consumer" . 1.4.2. CMS See Section 1.5.3, "Developer Portal" . 1.5. D 1.5.1. deprecated Pertaining to an entity, such as a feature or supported configuration, that is supported but no longer recommended and that might become obsolete. See also Section 1.19.1, "removed" . 1.5.2. developer account In 3scale Hosted, all accounts the API provider sees are developer accounts. In 3scale On-premises, in the tenant Admin Portal, accounts are considered as developer accounts. See also Section 1.2.21, "application" , Section 1.21.1, "tenant account" . 1.5.3. Developer Portal The site where developers can subscribe to APIs. From this site, developers can manage their subscription, have access to their APIs, create applications, access the interactive API documentation, 3scale API docs, see their API consumption, etc . See also Section 1.2.4, "Admin Portal" . 1.5.4. discontinued See Section 1.19.1, "removed" . 1.6. E 1.6.1. endpoint One end of a communication channel. When an API interacts with another system, the touchpoints of this communication are considered endpoints. See also Section 1.2.22, "application programming interface" , Section 1.3.2, "base URL" , Section 1.14.2, "mapping rule" , Section 1.14.3, "method" . 1.6.2. end user The user of an application which calls one or multiple products and APIs. See also Section 1.2.22, "application programming interface" , Section 1.17.3, "product" . 1.7. F 1.7.1. field definition Fields displayed when either a new user, application, or account is created. 1.8. G 1.9. H 1.9.1. hit The built-in metric to which all methods report. Additional top-level metrics can be added here in order to track other usage that should not increase the hit count. See also Section 1.14.4, "metric" . 1.9.2. host URL See Section 1.3.2, "base URL" . 1.10. I 1.10.1. integration error Error messages generated by 3scale when calls are performed with an incorrect set of credentials, incorrect IDs, URL addresses, etc . These messages can be errors coming from the application which is calling the API, or they can be a configuration error with the integration of the API with 3scale. 1.11. J 1.12. K 1.13. L 1.14. M 1.14.1. management portal See Section 1.2.4, "Admin Portal" . 1.14.2. mapping rule Rule that associates incoming calls from specific endpoints to the corresponding methods and metrics created in 3scale. Usage tracking, endpoint access and limits are based on the methods and metrics that are configured with mapping rules. See also Section 1.6.1, "endpoint" , Section 1.14.3, "method" , Section 1.14.4, "metric" . 1.14.3. method Allowed interactions -such as GET, POST or DELETE- with an API or a product. Methods are used to track the usage of products and API on 3scale. A method can be added for each of the HTTP methods available on the API endpoints for the API. By default, on 3scale, method calls trigger the built-in hits metric. See also Section 1.2.22, "application programming interface" , Section 1.6.1, "endpoint" , Section 1.14.2, "mapping rule" , Section 1.14.4, "metric" . 1.14.4. metric Track of specific calls to an API. This tracking is done by mapping the calls to one or more URL patterns in the Mapping Rules section of the integration page. Metrics are cumulative and not discrete. The built-in top level metric on 3scale is Hits. Additional top level metrics can be added if needed, and these are considered separately. See also Section 1.9.1, "hit" , Section 1.14.2, "mapping rule" , Section 1.14.3, "method" . 1.15. N 1.16. O 1.16.1. OAS See Section 1.16.2, "OpenAPI Specification" 1.16.2. OpenAPI Specification A standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. See also Section 1.1.5, "3scale API Management docs" , Section 1.2.2, "ActiveDocs" . 1.17. P 1.17.1. plan Approach for granting access to specific APIs and endpoints, limiting traffic and monetizing API usage. 3scale has different types of plans that can be used on their own or in conjunction, such as Application plans and Account plans. 1.17.2. potential upgrade Developer accounts that trigger traffic limit alerts. These developer accounts could potentially be upgraded to a plan which meets their needs in terms of traffic volume. 1.17.3. product A bundle of one or more API backends. See also Section 1.1.4, "[Your_product_name]" , Section 1.2.4, "Admin Portal" , Section 1.2.17, "APIcast" , Section 1.2.22, "application programming interface" , Section 1.3.1, "backend" , Section 1.6.2, "end user" . 1.18. Q 1.19. R 1.19.1. removed Pertaining to an entity, such as a feature or supported configuration, that is not available in the product and is no longer supported. See also Section 1.5.1, "deprecated" . 1.20. S 1.20.1. service See Section 1.2.22, "application programming interface" . 1.20.2. service token Key used to authenticate against the Service Management API. These keys are auto generated, unique per service, and shared between the users of an account. Use Service Tokens from within the 3scale API docs. See also Section 1.2.3, "access token" . 1.21. T 1.21.1. tenant account In 3scale on-premises, the Master Admin Portal considers accounts as tenant accounts. See also Section 1.2.12, "API provider" , Section 1.5.2, "developer account" . 1.22. U 1.23. upstream In 3scale API Management, upstream means the service protected by 3scale. When using 3scale APIcast, which works as a reverse proxy for the customer's service, upstream refers to the customer's service itself. APIcast acts as a go-between, handling and securing data flow between client requests and the customer's upstream service. 1.23.1. user key See Section 1.2.20, "app key" . 1.24. V 1.25. W 1.26. X 1.27. Y 1.27.1. your domain See Section 1.1.1, "[Your_admin_domain]" . 1.28. Z
null
https://docs.redhat.com/en/documentation/red_hat_3scale_api_management/2.15/html/glossary/threescale_api_management_glossary
Chapter 5. Managing user-owned OAuth access tokens
Chapter 5. Managing user-owned OAuth access tokens Users can review their own OAuth access tokens and delete any that are no longer needed. 5.1. Listing user-owned OAuth access tokens You can list your user-owned OAuth access tokens. Token names are not sensitive and cannot be used to log in. Procedure List all user-owned OAuth access tokens: USD oc get useroauthaccesstokens Example output NAME CLIENT NAME CREATED EXPIRES REDIRECT URI SCOPES <token1> openshift-challenging-client 2021-01-11T19:25:35Z 2021-01-12 19:25:35 +0000 UTC https://oauth-openshift.apps.example.com/oauth/token/implicit user:full <token2> openshift-browser-client 2021-01-11T19:27:06Z 2021-01-12 19:27:06 +0000 UTC https://oauth-openshift.apps.example.com/oauth/token/display user:full <token3> console 2021-01-11T19:26:29Z 2021-01-12 19:26:29 +0000 UTC https://console-openshift-console.apps.example.com/auth/callback user:full List user-owned OAuth access tokens for a particular OAuth client: USD oc get useroauthaccesstokens --field-selector=clientName="console" Example output NAME CLIENT NAME CREATED EXPIRES REDIRECT URI SCOPES <token3> console 2021-01-11T19:26:29Z 2021-01-12 19:26:29 +0000 UTC https://console-openshift-console.apps.example.com/auth/callback user:full 5.2. Viewing the details of a user-owned OAuth access token You can view the details of a user-owned OAuth access token. Procedure Describe the details of a user-owned OAuth access token: USD oc describe useroauthaccesstokens <token_name> Example output Name: <token_name> 1 Namespace: Labels: <none> Annotations: <none> API Version: oauth.openshift.io/v1 Authorize Token: sha256~Ksckkug-9Fg_RWn_AUysPoIg-_HqmFI9zUL_CgD8wr8 Client Name: openshift-browser-client 2 Expires In: 86400 3 Inactivity Timeout Seconds: 317 4 Kind: UserOAuthAccessToken Metadata: Creation Timestamp: 2021-01-11T19:27:06Z Managed Fields: API Version: oauth.openshift.io/v1 Fields Type: FieldsV1 fieldsV1: f:authorizeToken: f:clientName: f:expiresIn: f:redirectURI: f:scopes: f:userName: f:userUID: Manager: oauth-server Operation: Update Time: 2021-01-11T19:27:06Z Resource Version: 30535 Self Link: /apis/oauth.openshift.io/v1/useroauthaccesstokens/<token_name> UID: f9d00b67-ab65-489b-8080-e427fa3c6181 Redirect URI: https://oauth-openshift.apps.example.com/oauth/token/display Scopes: user:full 5 User Name: <user_name> 6 User UID: 82356ab0-95f9-4fb3-9bc0-10f1d6a6a345 Events: <none> 1 The token name, which is the sha256 hash of the token. Token names are not sensitive and cannot be used to log in. 2 The client name, which describes where the token originated from. 3 The value in seconds from the creation time before this token expires. 4 If there is a token inactivity timeout set for the OAuth server, this is the value in seconds from the creation time before this token can no longer be used. 5 The scopes for this token. 6 The user name associated with this token. 5.3. Deleting user-owned OAuth access tokens The oc logout command only invalidates the OAuth token for the active session. You can use the following procedure to delete any user-owned OAuth tokens that are no longer needed. Deleting an OAuth access token logs out the user from all sessions that use the token. Procedure Delete the user-owned OAuth access token: USD oc delete useroauthaccesstokens <token_name> Example output useroauthaccesstoken.oauth.openshift.io "<token_name>" deleted
[ "oc get useroauthaccesstokens", "NAME CLIENT NAME CREATED EXPIRES REDIRECT URI SCOPES <token1> openshift-challenging-client 2021-01-11T19:25:35Z 2021-01-12 19:25:35 +0000 UTC https://oauth-openshift.apps.example.com/oauth/token/implicit user:full <token2> openshift-browser-client 2021-01-11T19:27:06Z 2021-01-12 19:27:06 +0000 UTC https://oauth-openshift.apps.example.com/oauth/token/display user:full <token3> console 2021-01-11T19:26:29Z 2021-01-12 19:26:29 +0000 UTC https://console-openshift-console.apps.example.com/auth/callback user:full", "oc get useroauthaccesstokens --field-selector=clientName=\"console\"", "NAME CLIENT NAME CREATED EXPIRES REDIRECT URI SCOPES <token3> console 2021-01-11T19:26:29Z 2021-01-12 19:26:29 +0000 UTC https://console-openshift-console.apps.example.com/auth/callback user:full", "oc describe useroauthaccesstokens <token_name>", "Name: <token_name> 1 Namespace: Labels: <none> Annotations: <none> API Version: oauth.openshift.io/v1 Authorize Token: sha256~Ksckkug-9Fg_RWn_AUysPoIg-_HqmFI9zUL_CgD8wr8 Client Name: openshift-browser-client 2 Expires In: 86400 3 Inactivity Timeout Seconds: 317 4 Kind: UserOAuthAccessToken Metadata: Creation Timestamp: 2021-01-11T19:27:06Z Managed Fields: API Version: oauth.openshift.io/v1 Fields Type: FieldsV1 fieldsV1: f:authorizeToken: f:clientName: f:expiresIn: f:redirectURI: f:scopes: f:userName: f:userUID: Manager: oauth-server Operation: Update Time: 2021-01-11T19:27:06Z Resource Version: 30535 Self Link: /apis/oauth.openshift.io/v1/useroauthaccesstokens/<token_name> UID: f9d00b67-ab65-489b-8080-e427fa3c6181 Redirect URI: https://oauth-openshift.apps.example.com/oauth/token/display Scopes: user:full 5 User Name: <user_name> 6 User UID: 82356ab0-95f9-4fb3-9bc0-10f1d6a6a345 Events: <none>", "oc delete useroauthaccesstokens <token_name>", "useroauthaccesstoken.oauth.openshift.io \"<token_name>\" deleted" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.10/html/authentication_and_authorization/managing-oauth-access-tokens
Chapter 8. Getting Directory Server access log using the command line
Chapter 8. Getting Directory Server access log using the command line The logconv.pl command analyzes Directory Server access logs, extracts usage statistics, and counts occurrences of significant events specified on the command line. The logconv.pl command prints a list of total operations, total number of connections, counts per each operation type, counts for some extended operations like persistent searches, and bind information. The logconv.pl command has the following syntax: To analyze multiple access log files, you can use the following format with an asterisk (*): The logconv.pl command generates following three types of statistics that are useful for monitoring the Directory Server and optimizing Directory Server configuration: Counts of events, such as total binds and total searches performed. Lists of the most frequently occurring parameters in LDAP requests. For example, the logconv.pl command generates lists of the top ten bind DNs, base DNs, filter strings, and attributes returned. Counts of occurrences for error codes such as those defined in ldap.h . 8.1. Analyzing Directory Server access logs using the command line The logconv.pl command analyzes Directory Server access logs and extracts usage statistics and counts occurrences of significant events. The logconv.pl takes following options: -S : specifies the time to begin the log file analysis. -E : specifies the time to stop the log files analysis. -bc : generates a report based on the number of DNs used to connect to the server and the total connection codes the server returns. -m : generates output data per second ( -m ) to a specified CSV output file. -M : generates output data with counts per minute ( -M ) to a specified CSV output file. Procedure To generate a simple access log summary, run the following command: The logconv.pl script prints a list of total operations, total number of connections, counts per each operation type, counts for some extended operations like persistent searches, and bind information. Optional: If you must enable additional connection summaries passed as a single option, such as the number of DNs used to connect to the server ( b ) and the total connection codes the server ( c ) returns, specify the -bc option as follows: Optional: If you must enable data output for a certain start ( -S ) and end time ( -E ) or within a specific range, run the following command When start and end times are set, the logconv.pl command first prints the time range given, then the summary for that period. Optional: If you must enable data output with counts per minute ( -M ) or per second ( -m ), run the following command:
[ "logconv.pl/path/to/accesslog", "logconv.pl /var/log/dirsrv/slapd- instance_name /access*", "logconv.pl /var/log/dirsrv/slapd- instance_name /access Access Log Analyzer 8.2 Command: logconv.pl /var/log/dirsrv/slapd- instance_name /access Processing 1 Access Log(s) [001] /var/log/dirsrv/slapd- instance_name /access size(bytes):77532 Total Log Lines Analysed: 527 Start of Logs: 14/Oct/2017:16:15:22.452909568 End of Logs: 14/Oct/2017:16:39:50.157790196 Processed Log Time: 0 Hours, 24 Minutes, 27.704877056 Seconds Restarts: 10 Secure Protocol Versions: - TLS1.2 client bound as uid=user_name,ou=people,o=example.com (11 connections) - TLS1.2 128-bit AES; client CN=CA Subsystem,O=example.com; issuer CN=Certificate Authority,O=example.com (11 connections) - TLS1.2 128-bit AES-GCM (2 connections) - TLS1.2 128-bit AES (3 connections) Peak Concurrent Connections: 38 Total Operations: 4771 Total Results: 4653 Overall Performance: 97.5% Total Connections: 249 (0.17/sec) (10.18/min) - LDAP Connections: 107 (0.07/sec) (4.37/min) - LDAPI Connections: 128 (0.09/sec) (5.23/min) - LDAPS Connections: 14 (0.01/sec) (0.57/min) - StartTLS Extended Ops: 2 (0.00/sec) (0.08/min) Searches: 2963 (2.02/sec) (121.13/min) Modifications: 649 (0.44/sec) (26.53/min) Adds: 785 (0.53/sec) (32.09/min) Deletes: 10 (0.01/sec) (0.41/min) Mod RDNs: 6 (0.00/sec) (0.25/min) Compares: 0 (0.00/sec) (0.00/min) Binds: 324 (0.22/sec) (13.25/min) Proxied Auth Operations: 0 Persistent Searches: 17 Internal Operations: 0 Entry Operations: 0 Extended Operations: 4 Abandoned Requests: 0 Smart Referrals Received: 0 VLV Operations: 30 VLV Unindexed Searches: 0 VLV Unindexed Components: 20 SORT Operations: 22 Entire Search Base Queries: 12 Paged Searches: 2 Unindexed Searches: 0 Unindexed Components: 149 FDs Taken: 249 FDs Returned: 212 Highest FD Taken: 107 Broken Pipes: 0 Connections Reset By Peer: 0 Resource Unavailable: 0 Max BER Size Exceeded: 0 Binds: 324 Unbinds: 155 --------------------------------- - LDAP v2 Binds: 41 - LDAP v3 Binds: 180 - AUTOBINDs(LDAPI): 103 - SSL Client Binds: 0 - Failed SSL Client Binds: 0 - SASL Binds: 134 - EXTERNAL: 114 - GSSAPI: 20 - Directory Manager Binds: 10 - Anonymous Binds: 1 Cleaning up temp files Done.", "lotgconv.pl -bc /var/log/dirsrv/slapd- instance_name /access ----- Total Connection Codes ----- U1 3 Cleanly Closed Connections B1 1 Bad Ber Tag Encountered ----- Top 20 Bind DN's ----- Number of Unique Bind DN's: 212 1801 cn=Directory Manager 1297 Anonymous Binds 311 uid=jsmith,ou=people 87 uid=bjensen,ou=peopl 85 uid=mreynolds,ou=peo 69 uid=jrockford,ou=peo 55 uid=sspencer,ou=peop", "logconv.pl -S \"[01/Jul/2022:16:11:47.000000000 -0400]\" -E \"[01/Jul/2022:17:23:08.999999999 -0400]\" /var/log/dirsrv/slapd- instance_name /access ----------- Access Log Output ------------ Start of Logs: 01/Jul/2022:16:11:47 End of Logs: 01/Jul/2022:17:23:08", "logconv.pl -m|-M outputFile accessLogFile" ]
https://docs.redhat.com/en/documentation/red_hat_directory_server/12/html/monitoring_server_and_database_activity/assembly_getting-directory-server-access-log-using-the-command-line_monitoring-server-and-database-activities
Chapter 23. Extract Field Action
Chapter 23. Extract Field Action Extract a field from the body 23.1. Configuration Options The following table summarizes the configuration options available for the extract-field-action Kamelet: Property Name Description Type Default Example field * Field The name of the field to be added string Note Fields marked with an asterisk (*) are mandatory. 23.2. Dependencies At runtime, the extract-field-action Kamelet relies upon the presence of the following dependencies: github:openshift-integration.kamelet-catalog:camel-kamelets-utils:kamelet-catalog-1.6-SNAPSHOT camel:kamelet camel:core camel:jackson 23.3. Usage This section describes how you can use the extract-field-action . 23.3.1. Knative Action You can use the extract-field-action Kamelet as an intermediate step in a Knative binding. extract-field-action-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: extract-field-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: extract-field-action properties: field: "The Field" sink: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel 23.3.1.1. Prerequisite Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 23.3.1.2. Procedure for using the cluster CLI Save the extract-field-action-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the action by using the following command: oc apply -f extract-field-action-binding.yaml 23.3.1.3. Procedure for using the Kamel CLI Configure and run the action by using the following command: kamel bind timer-source?message=Hello --step extract-field-action -p "step-0.field=The Field" channel:mychannel This command creates the KameletBinding in the current namespace on the cluster. 23.3.2. Kafka Action You can use the extract-field-action Kamelet as an intermediate step in a Kafka binding. extract-field-action-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: extract-field-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: "Hello" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: extract-field-action properties: field: "The Field" sink: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic 23.3.2.1. Prerequisites Ensure that you've installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 23.3.2.2. Procedure for using the cluster CLI Save the extract-field-action-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the action by using the following command: oc apply -f extract-field-action-binding.yaml 23.3.2.3. Procedure for using the Kamel CLI Configure and run the action by using the following command: kamel bind timer-source?message=Hello --step extract-field-action -p "step-0.field=The Field" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic This command creates the KameletBinding in the current namespace on the cluster. 23.4. Kamelet source file https://github.com/openshift-integration/kamelet-catalog/extract-field-action.kamelet.yaml
[ "apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: extract-field-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: \"Hello\" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: extract-field-action properties: field: \"The Field\" sink: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel", "apply -f extract-field-action-binding.yaml", "kamel bind timer-source?message=Hello --step extract-field-action -p \"step-0.field=The Field\" channel:mychannel", "apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: extract-field-action-binding spec: source: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: timer-source properties: message: \"Hello\" steps: - ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: extract-field-action properties: field: \"The Field\" sink: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic", "apply -f extract-field-action-binding.yaml", "kamel bind timer-source?message=Hello --step extract-field-action -p \"step-0.field=The Field\" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic" ]
https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel_k/1.10.9/html/kamelets_reference/extract-field-action
Appendix B. Metadata Server daemon configuration Reference
Appendix B. Metadata Server daemon configuration Reference Refer to this list of commands that can be used for the Metadata Server (MDS) daemon configuration. mon_force_standby_active Description If set to true , monitors force MDS in standby replay mode to be active. Set under the [mon] or [global] section in the Ceph configuration file. Type Boolean Default true max_mds Description The number of active MDS daemons during cluster creation. Set under the [mon] or [global] section in the Ceph configuration file. Type 32-bit Integer Default 1 mds_cache_memory_limit Description The memory limit the MDS enforces for its cache. Red Hat recommends using this parameter instead of the mds cache size parameter. Type 64-bit Integer Unsigned Default 4294967296 mds_cache_reservation Description The cache reservation, memory or inodes, for the MDS cache to maintain. The value is a percentage of the maximum cache configured. Once the MDS begins dipping into its reservation, it recalls client state until its cache size shrinks to restore the reservation. Type Float Default 0.05 mds_cache_size Description The number of inodes to cache. A value of 0 indicates an unlimited number. Red Hat recommends to use the mds_cache_memory_limit to limit the amount of memory the MDS cache uses. Type 32-bit Integer Default 0 mds_cache_mid Description The insertion point for new items in the cache LRU, from the top. Type Float Default 0.7 mds_dir_commit_ratio Description The fraction of directory that contains erroneous information before Ceph commits using a full update instead of partial update. Type Float Default 0.5 mds_dir_max_commit_size Description The maximum size of a directory update in MB before Ceph breaks the directory into smaller transactions. Type 32-bit Integer Default 90 mds_decay_halflife Description The half-life of the MDS cache temperature. Type Float Default 5 mds_beacon_interval Description The frequency, in seconds, of beacon messages sent to the monitor. Type Float Default 4 mds_beacon_grace Description The interval without beacons before Ceph declares a MDS laggy and possibly replaces it. Type Float Default 15 mds_blacklist_interval Description The blacklist duration for failed MDS daemons in the OSD map. Type Float Default 24.0*60.0 mds_session_timeout Description The interval, in seconds, of client inactivity before Ceph times out capabilities and leases. Type Float Default 60 mds_session_autoclose Description The interval, in seconds, before Ceph closes a laggy client's session. Type Float Default 300 mds_reconnect_timeout Description The interval, in seconds, to wait for clients to reconnect during a MDS restart. Type Float Default 45 mds_tick_interval Description How frequently the MDS performs internal periodic tasks. Type Float Default 5 mds_dirstat_min_interval Description The minimum interval, in seconds, to try to avoid propagating recursive statistics up the tree. Type Float Default 1 mds_scatter_nudge_interval Description How quickly changes in directory statistics propagate up. Type Float Default 5 mds_client_prealloc_inos Description The number of inode numbers to preallocate per client session. Type 32-bit Integer Default 1000 mds_early_reply Description Determines whether the MDS allows clients to see request results before they commit to the journal. Type Boolean Default true mds_use_tmap Description Use trivialmap for directory updates. Type Boolean Default true mds_default_dir_hash Description The function to use for hashing files across directory fragments. Type 32-bit Integer Default 2 ,that is, rjenkins mds_log Description Set to true if the MDS should journal metadata updates. Disable for benchmarking only. Type Boolean Default true mds_log_skip_corrupt_events Description Determines whether the MDS tries to skip corrupt journal events during journal replay. Type Boolean Default false mds_log_max_events Description The maximum events in the journal before Ceph initiates trimming. Set to -1 to disable limits. Type 32-bit Integer Default -1 mds_log_max_segments Description The maximum number of segments or objects in the journal before Ceph initiates trimming. Set to -1 to disable limits. Type 32-bit Integer Default 30 mds_log_max_expiring Description The maximum number of segments to expire in parallels. Type 32-bit Integer Default 20 mds_log_eopen_size Description The maximum number of inodes in an EOpen event. Type 32-bit Integer Default 100 mds_bal_sample_interval Description Determines how frequently to sample directory temperature when making fragmentation decisions. Type Float Default 3 mds_bal_replicate_threshold Description The maximum temperature before Ceph attempts to replicate metadata to other nodes. Type Float Default 8000 mds_bal_unreplicate_threshold Description The minimum temperature before Ceph stops replicating metadata to other nodes. Type Float Default 0 mds_bal_frag Description Determines whether or not the MDS fragments directories. Type Boolean Default false mds_bal_split_size Description The maximum directory size before the MDS splits a directory fragment into smaller bits. The root directory has a default fragment size limit of 10000. Type 32-bit Integer Default 10000 mds_bal_split_rd Description The maximum directory read temperature before Ceph splits a directory fragment. Type Float Default 25000 mds_bal_split_wr Description The maximum directory write temperature before Ceph splits a directory fragment. Type Float Default 10000 mds_bal_split_bits Description The number of bits by which to split a directory fragment. Type 32-bit Integer Default 3 mds_bal_merge_size Description The minimum directory size before Ceph tries to merge adjacent directory fragments. Type 32-bit Integer Default 50 mds_bal_merge_rd Description The minimum read temperature before Ceph merges adjacent directory fragments. Type Float Default 1000 mds_bal_merge_wr Description The minimum write temperature before Ceph merges adjacent directory fragments. Type Float Default 1000 mds_bal_interval Description The frequency, in seconds, of workload exchanges between MDS nodes. Type 32-bit Integer Default 10 mds_bal_fragment_interval Description The frequency, in seconds, of adjusting directory fragmentation. Type 32-bit Integer Default 5 mds_bal_idle_threshold Description The minimum temperature before Ceph migrates a subtree back to its parent. Type Float Default 0 mds_bal_max Description The number of iterations to run balancer before Ceph stops. For testing purposes only. Type 32-bit Integer Default -1 mds_bal_max_until Description The number of seconds to run balancer before Ceph stops. For testing purposes only. Type 32-bit Integer Default -1 mds_bal_mode Description The method for calculating MDS load: 1 = Hybrid. 2 = Request rate and latency. 3 = CPU load. Type 32-bit Integer Default 0 mds_bal_min_rebalance Description The minimum subtree temperature before Ceph migrates. Type Float Default 0.1 mds_bal_min_start Description The minimum subtree temperature before Ceph searches a subtree. Type Float Default 0.2 mds_bal_need_min Description The minimum fraction of target subtree size to accept. Type Float Default 0.8 mds_bal_need_max Description The maximum fraction of target subtree size to accept. Type Float Default 1.2 mds_bal_midchunk Description Ceph migrates any subtree that is larger than this fraction of the target subtree size. Type Float Default 0.3 mds_bal_minchunk Description Ceph ignores any subtree that is smaller than this fraction of the target subtree size. Type Float Default 0.001 mds_bal_target_removal_min Description The minimum number of balancer iterations before Ceph removes an old MDS target from the MDS map. Type 32-bit Integer Default 5 mds_bal_target_removal_max Description The maximum number of balancer iterations before Ceph removes an old MDS target from the MDS map. Type 32-bit Integer Default 10 mds_replay_interval Description The journal poll interval when in standby-replay mode for a hot standby . Type Float Default 1 mds_shutdown_check Description The interval for polling the cache during MDS shutdown. Type 32-bit Integer Default 0 mds_thrash_exports Description Ceph randomly exports subtrees between nodes. For testing purposes only. Type 32-bit Integer Default 0 mds_thrash_fragments Description Ceph randomly fragments or merges directories. Type 32-bit Integer Default 0 mds_dump_cache_on_map Description Ceph dumps the MDS cache contents to a file on each MDS map. Type Boolean Default false mds_dump_cache_after_rejoin Description Ceph dumps MDS cache contents to a file after rejoining the cache during recovery. Type Boolean Default false mds_verify_scatter Description Ceph asserts that various scatter/gather invariants are true . For developer use only. Type Boolean Default false mds_debug_scatterstat Description Ceph asserts that various recursive statistics invariants are true . For developer use only. Type Boolean Default false mds_debug_frag Description Ceph verifies directory fragmentation invariants when convenient. For developer use only. Type Boolean Default false mds_debug_auth_pins Description The debug authentication pin invariants. For developer use only. Type Boolean Default false mds_debug_subtrees Description Debugging subtree invariants. For developer use only. Type Boolean Default false mds_kill_mdstable_at Description Ceph injects a MDS failure in a MDS Table code. For developer use only. Type 32-bit Integer Default 0 mds_kill_export_at Description Ceph injects a MDS failure in the subtree export code. For developer use only. Type 32-bit Integer Default 0 mds_kill_import_at Description Ceph injects a MDS failure in the subtree import code. For developer use only. Type 32-bit Integer Default 0 mds_kill_link_at Description Ceph injects a MDS failure in a hard link code. For developer use only. Type 32-bit Integer Default 0 mds_kill_rename_at Description Ceph injects a MDS failure in the rename code. For developer use only. Type 32-bit Integer Default 0 mds_wipe_sessions Description Ceph deletes all client sessions on startup. For testing purposes only. Type Boolean Default 0 mds_wipe_ino_prealloc Description Ceph deletes inode preallocation metadata on startup. For testing purposes only. Type Boolean Default 0 mds_skip_ino Description The number of inode numbers to skip on startup. For testing purposes only. Type 32-bit Integer Default 0 mds_standby_for_name Description The MDS daemon is a standby for another MDS daemon of the name specified in this setting. Type String Default N/A mds_standby_for_rank Description An instance of the MDS daemon is a standby for another MDS daemon instance of this rank. Type 32-bit Integer Default -1 mds_standby_replay Description Determines whether the MDS daemon polls and replays the log of an active MDS when used as a hot standby . Type Boolean Default false
null
https://docs.redhat.com/en/documentation/red_hat_ceph_storage/6/html/file_system_guide/metadata-server-daemon-configuration-reference_fs
4.2. Disk
4.2. Disk The following sections showcase scripts that monitor disk and I/O activity. 4.2.1. Summarizing Disk Read/Write Traffic This section describes how to identify which processes are performing the heaviest disk reads/writes to the system. Example 4.9. disktop.stp #!/usr/bin/stap # #
[ "#!/usr/bin/stap # Copyright (C) 2007 Oracle Corp. # Get the status of reading/writing disk every 5 seconds, output top ten entries # This is free software,GNU General Public License (GPL); either version 2, or (at your option) any later version. # Usage: ./disktop.stp # global io_stat,device global read_bytes,write_bytes probe vfs.read.return { if (USDreturn>0) { if (devname!=\"N/A\") {/*skip read from cache*/ io_stat[pid(),execname(),uid(),ppid(),\"R\"] += USDreturn device[pid(),execname(),uid(),ppid(),\"R\"] = devname read_bytes += USDreturn } } } probe vfs.write.return { if (USDreturn>0) { if (devname!=\"N/A\") { /*skip update cache*/ io_stat[pid(),execname(),uid(),ppid(),\"W\"] += USDreturn device[pid(),execname(),uid(),ppid(),\"W\"] = devname write_bytes += USDreturn } } } probe timer.ms(5000) { /* skip non-read/write disk */ if (read_bytes+write_bytes) { printf(\"\\n%-25s, %-8s%4dKb/sec, %-7s%6dKb, %-7s%6dKb\\n\\n\", ctime(gettimeofday_s()), \"Average:\", ((read_bytes+write_bytes)/1024)/5, \"Read:\",read_bytes/1024, \"Write:\",write_bytes/1024) /* print header */ printf(\"%8s %8s %8s %25s %8s %4s %12s\\n\", \"UID\",\"PID\",\"PPID\",\"CMD\",\"DEVICE\",\"T\",\"BYTES\") } /* print top ten I/O */ foreach ([process,cmd,userid,parent,action] in io_stat- limit 10) printf(\"%8d %8d %8d %25s %8s %4s %12d\\n\", userid,process,parent,cmd, device[process,cmd,userid,parent,action], action,io_stat[process,cmd,userid,parent,action]) /* clear data */ delete io_stat delete device read_bytes = 0 write_bytes = 0 } probe end{ delete io_stat delete device delete read_bytes delete write_bytes }", "[...] Mon Sep 29 03:38:28 2008 , Average: 19Kb/sec, Read: 7Kb, Write: 89Kb UID PID PPID CMD DEVICE T BYTES 0 26319 26294 firefox sda5 W 90229 0 2758 2757 pam_timestamp_c sda5 R 8064 0 2885 1 cupsd sda5 W 1678 Mon Sep 29 03:38:38 2008 , Average: 1Kb/sec, Read: 7Kb, Write: 1Kb UID PID PPID CMD DEVICE T BYTES 0 2758 2757 pam_timestamp_c sda5 R 8064 0 2885 1 cupsd sda5 W 1678", "global start global entry_io global fd_io global time_io function timestamp:long() { return gettimeofday_us() - start } function proc:string() { return sprintf(\"%d (%s)\", pid(), execname()) } probe begin { start = gettimeofday_us() } global filenames global filehandles global fileread global filewrite probe syscall.open { filenames[pid()] = user_string(USDfilename) } probe syscall.open.return { if (USDreturn != -1) { filehandles[pid(), USDreturn] = filenames[pid()] fileread[pid(), USDreturn] = 0 filewrite[pid(), USDreturn] = 0 } else { printf(\"%d %s access %s fail\\n\", timestamp(), proc(), filenames[pid()]) } delete filenames[pid()] } probe syscall.read { if (USDcount > 0) { fileread[pid(), USDfd] += USDcount } t = gettimeofday_us(); p = pid() entry_io[p] = t fd_io[p] = USDfd } probe syscall.read.return { t = gettimeofday_us(); p = pid() fd = fd_io[p] time_io[p,fd] <<< t - entry_io[p] } probe syscall.write { if (USDcount > 0) { filewrite[pid(), USDfd] += USDcount } t = gettimeofday_us(); p = pid() entry_io[p] = t fd_io[p] = USDfd } probe syscall.write.return { t = gettimeofday_us(); p = pid() fd = fd_io[p] time_io[p,fd] <<< t - entry_io[p] } probe syscall.close { if (filehandles[pid(), USDfd] != \"\") { printf(\"%d %s access %s read: %d write: %d\\n\", timestamp(), proc(), filehandles[pid(), USDfd], fileread[pid(), USDfd], filewrite[pid(), USDfd]) if (@count(time_io[pid(), USDfd])) printf(\"%d %s iotime %s time: %d\\n\", timestamp(), proc(), filehandles[pid(), USDfd], @sum(time_io[pid(), USDfd])) } delete fileread[pid(), USDfd] delete filewrite[pid(), USDfd] delete filehandles[pid(), USDfd] delete fd_io[pid()] delete entry_io[pid()] delete time_io[pid(),USDfd] }", "[...] 825946 3364 (NetworkManager) access /sys/class/net/eth0/carrier read: 8190 write: 0 825955 3364 (NetworkManager) iotime /sys/class/net/eth0/carrier time: 9 [...] 117061 2460 (pcscd) access /dev/bus/usb/003/001 read: 43 write: 0 117065 2460 (pcscd) iotime /dev/bus/usb/003/001 time: 7 [...] 3973737 2886 (sendmail) access /proc/loadavg read: 4096 write: 0 3973744 2886 (sendmail) iotime /proc/loadavg time: 11 [...]", "#! /usr/bin/env stap traceio.stp Copyright (C) 2007 Red Hat, Inc., Eugene Teo <[email protected]> Copyright (C) 2009 Kai Meyer <[email protected]> Fixed a bug that allows this to run longer And added the humanreadable function # This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. # global reads, writes, total_io probe vfs.read.return { reads[pid(),execname()] += USDreturn total_io[pid(),execname()] += USDreturn } probe vfs.write.return { writes[pid(),execname()] += USDreturn total_io[pid(),execname()] += USDreturn } function humanreadable(bytes) { if (bytes > 1024*1024*1024) { return sprintf(\"%d GiB\", bytes/1024/1024/1024) } else if (bytes > 1024*1024) { return sprintf(\"%d MiB\", bytes/1024/1024) } else if (bytes > 1024) { return sprintf(\"%d KiB\", bytes/1024) } else { return sprintf(\"%d B\", bytes) } } probe timer.s(1) { foreach([p,e] in total_io- limit 10) printf(\"%8d %15s r: %12s w: %12s\\n\", p, e, humanreadable(reads[p,e]), humanreadable(writes[p,e])) printf(\"\\n\") # Note we don't zero out reads, writes and total_io, # so the values are cumulative since the script started. }", "[...] Xorg r: 583401 KiB w: 0 KiB floaters r: 96 KiB w: 7130 KiB multiload-apple r: 538 KiB w: 537 KiB sshd r: 71 KiB w: 72 KiB pam_timestamp_c r: 138 KiB w: 0 KiB staprun r: 51 KiB w: 51 KiB snmpd r: 46 KiB w: 0 KiB pcscd r: 28 KiB w: 0 KiB irqbalance r: 27 KiB w: 4 KiB cupsd r: 4 KiB w: 18 KiB Xorg r: 588140 KiB w: 0 KiB floaters r: 97 KiB w: 7143 KiB multiload-apple r: 543 KiB w: 542 KiB sshd r: 72 KiB w: 72 KiB pam_timestamp_c r: 138 KiB w: 0 KiB staprun r: 51 KiB w: 51 KiB snmpd r: 46 KiB w: 0 KiB pcscd r: 28 KiB w: 0 KiB irqbalance r: 27 KiB w: 4 KiB cupsd r: 4 KiB w: 18 KiB", "#! /usr/bin/env stap global device_of_interest probe begin { /* The following is not the most efficient way to do this. One could directly put the result of usrdev2kerndev() into device_of_interest. However, want to test out the other device functions */ dev = usrdev2kerndev(USD1) device_of_interest = MKDEV(MAJOR(dev), MINOR(dev)) } probe vfs.write, vfs.read { if (dev == device_of_interest) printf (\"%s(%d) %s 0x%x\\n\", execname(), pid(), probefunc(), dev) }", "[...] synergyc(3722) vfs_read 0x800005 synergyc(3722) vfs_read 0x800005 cupsd(2889) vfs_write 0x800005 cupsd(2889) vfs_write 0x800005 cupsd(2889) vfs_write 0x800005 [...]", "#! /usr/bin/env stap probe vfs.write, vfs.read { # dev and ino are defined by vfs.write and vfs.read if (dev == MKDEV(USD1,USD2) # major/minor device && ino == USD3) printf (\"%s(%d) %s 0x%x/%u\\n\", execname(), pid(), probefunc(), dev, ino) }", "805 1078319", "cat(16437) vfs_read 0x800005/1078319 cat(16437) vfs_read 0x800005/1078319", "global ATTR_MODE = 1 probe kernel.function(\"inode_setattr\") { dev_nr = USDinode->i_sb->s_dev inode_nr = USDinode->i_ino if (dev_nr == (USD1 << 20 | USD2) # major/minor device && inode_nr == USD3 && USDattr->ia_valid & ATTR_MODE) printf (\"%s(%d) %s 0x%x/%u %o %d\\n\", execname(), pid(), probefunc(), dev_nr, inode_nr, USDattr->ia_mode, uid()) }", "chmod(17448) inode_setattr 0x800005/6011835 100777 500 chmod(17449) inode_setattr 0x800005/6011835 100666 500" ]
https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/systemtap_beginners_guide/mainsect-disk
Chapter 34. File
Chapter 34. File Both producer and consumer are supported The File component provides access to file systems, allowing files to be processed by any other Camel Components or messages from other components to be saved to disk. 34.1. Dependencies When using file with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-file-starter</artifactId> </dependency> 34.2. URI format Where directoryName represents the underlying file directory. Only directories Camel supports only endpoints configured with a starting directory. So the directoryName must be a directory. If you want to consume a single file only, you can use the fileName option, e.g. by setting fileName=thefilename . Also, the starting directory must not contain dynamic expressions with USD{ } placeholders. Again use the fileName option to specify the dynamic part of the filename. Note Avoid reading files currently being written by another application Beware the JDK File IO API is a bit limited in detecting whether another application is currently writing/copying a file. And the implementation can be different depending on OS platform as well. This could lead to that Camel thinks the file is not locked by another process and start consuming it. Therefore you have to do you own investigation what suites your environment. To help with this Camel provides different readLock options and doneFileName option that you can use. See also the section Consuming files from folders where others drop files directly . 34.3. Configuring Options Camel components are configured on two levels: Component level Endpoint level 34.3.1. Component Level Options The component level is the highest level. The configurations you define at this level are inherited by all the endpoints. For example, a component can have security settings, credentials for authentication, urls for network connection, and so on. Since components typically have pre-configured defaults for the most common cases, you may need to only configure a few component options, or maybe none at all. You can configure components with Component DSL in a configuration file (application.properties|yaml), or directly with Java code. 34.3.2. Endpoint Level Options At the Endpoint level you have many options, which you can use to configure what you want the endpoint to do. The options are categorized according to whether the endpoint is used as a consumer (from) or as a producer (to) or used for both. You can configure endpoints directly in the endpoint URI as path and query parameters. You can also use Endpoint DSL and DataFormat DSL as type safe ways of configuring endpoints and data formats in Java. When configuring options, use Property Placeholders for urls, port numbers, sensitive information, and other settings. Placeholders allows you to externalize the configuration from your code, giving you more flexible and reusable code. 34.4. Component Options The File component supports 3 options, which are listed below. Name Description Default Type bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean 34.5. Endpoint Options The File endpoint is configured using URI syntax: with the following path and query parameters: 34.5.1. Path Parameters (1 parameters) Name Description Default Type directoryName (common) Required The starting directory. File 34.5.2. Query Parameters (94 parameters) Name Description Default Type charset (common) This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. String doneFileName (common) Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only USD\\{file.name} and USD\\{file.name.} is supported as dynamic placeholders. String fileName (common) Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-USD\\{date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. String bridgeErrorHandler (consumer) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean delete (consumer) If true, the file will be deleted after it is processed successfully. false boolean moveFailed (consumer) Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. String noop (consumer) If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again. false boolean preMove (consumer) Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. String preSort (consumer) When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled. false boolean recursive (consumer) If a directory, will look for files in all the sub-directories as well. false boolean sendEmptyMessageWhenIdle (consumer) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. false boolean directoryMustExist (consumer (advanced)) Similar to the startingDirectoryMustExist option but this applies during polling (after starting the consumer). false boolean exceptionHandler (consumer (advanced)) To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. ExceptionHandler exchangePattern (consumer (advanced)) Sets the exchange pattern when the consumer creates an exchange. Enum values: InOnly InOut InOptionalOut ExchangePattern extendedAttributes (consumer (advanced)) To define which file attributes of interest. Like posix:permissions,posix:owner,basic:lastAccessTime, it supports basic wildcard like posix:, basic:lastAccessTime. String inProgressRepository (consumer (advanced)) A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. IdempotentRepository localWorkDirectory (consumer (advanced)) When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. String onCompletionExceptionHandler (consumer (advanced)) To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. ExceptionHandler pollStrategy (consumer (advanced)) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. PollingConsumerPollStrategy probeContentType (consumer (advanced)) Whether to enable probing of the content type. If enable then the consumer uses Files#probeContentType(java.nio.file.Path) to determine the content-type of the file, and store that as a header with key Exchange#FILE_CONTENT_TYPE on the Message. false boolean processStrategy (consumer (advanced)) A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. GenericFileProcessStrategy resumeStrategy (consumer (advanced)) Set a resume strategy for files. This makes it possible to define a strategy for resuming reading files after the last point before stopping the application. See the FileConsumerResumeStrategy for implementation details. FileConsumerResumeStrategy startingDirectoryMustExist (consumer (advanced)) Whether the starting directory must exist. Mind that the autoCreate option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. false boolean startingDirectoryMustHaveAccess (consumer (advanced)) Whether the starting directory has access permissions. Mind that the startingDirectoryMustExist parameter must be set to true in order to verify that the directory exists. Will thrown an exception if the directory doesn't have read and write permissions. false boolean appendChars (producer) Used to append characters (text) after writing files. This can for example be used to add new lines or other separators when writing and appending new files or existing files. To specify new-line (slash-n or slash-r) or tab (slash-t) characters then escape with an extra slash, eg slash-slash-n. String fileExist (producer) What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers. Enum values: Override Append Fail Ignore Move TryRename Override GenericFileExist flatten (producer) Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. false boolean jailStartingDirectory (producer) Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. true boolean lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean moveExisting (producer) Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base. String tempFileName (producer) The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir. String tempPrefix (producer) This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files. String allowNullBody (producer (advanced)) Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged. false boolean chmod (producer (advanced)) Specify the file permissions which is sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it. String chmodDirectory (producer (advanced)) Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it. String eagerDeleteTargetFile (producer (advanced)) Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation. true boolean forceWrites (producer (advanced)) Whether to force syncing writes to the file system. You can turn this off if you do not want this level of guarantee, for example if writing to logs / audit logs etc; this would yield better performance. true boolean keepLastModified (producer (advanced)) Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. false boolean moveExistingFileStrategy (producer (advanced)) Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided. FileMoveExistingStrategy autoCreate (advanced) Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. true boolean bufferSize (advanced) Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files). 131072 int copyAndDeleteOnRenameFail (advanced) Whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component. true boolean renameUsingCopy (advanced) Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays. false boolean synchronous (advanced) Sets whether synchronous processing should be strictly used. false boolean antExclude (filter) Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. String antFilterCaseSensitive (filter) Sets case sensitive flag on ant filter. true boolean antInclude (filter) Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. String eagerMaxMessagesPerPoll (filter) Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. true boolean exclude (filter) Is used to exclude files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. String excludeExt (filter) Is used to exclude files matching file extension name (case insensitive). For example to exclude bak files, then use excludeExt=bak. Multiple extensions can be separated by comma, for example to exclude bak and dat files, use excludeExt=bak,dat. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options. String filter (filter) Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. GenericFileFilter filterDirectory (filter) Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as USD\\{date:now:yyyMMdd}. String filterFile (filter) Filters the file based on Simple language. For example to filter on file size, you can use USD\\{file:size} 5000. String idempotent (filter) Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. false Boolean idempotentKey (filter) To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=USD\\{file:name}-USD\\{file:size}. String idempotentRepository (filter) A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryIdempotentRepository if none is specified and idempotent is true. IdempotentRepository include (filter) Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris. String includeExt (filter) Is used to include files matching file extension name (case insensitive). For example to include txt files, then use includeExt=txt. Multiple extensions can be separated by comma, for example to include txt and xml files, use includeExt=txt,xml. Note that the file extension includes all parts, for example having a file named mydata.tar.gz will have extension as tar.gz. For more flexibility then use the include/exclude options. String maxDepth (filter) The maximum depth to traverse when recursively processing a directory. 2147483647 int maxMessagesPerPoll (filter) To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. int minDepth (filter) The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. int move (filter) Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. String exclusiveReadLockStrategy (lock) Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. GenericFileExclusiveReadLockStrategy readLock (lock) Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: - none - No read lock is in use - markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component - changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. - fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. - rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. - idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. - idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that.Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan. Enum values: none markerFile fileLock rename changed idempotent idempotent-changed idempotent-rename none String readLockCheckInterval (lock) Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. 1000 long readLockDeleteOrphanLockFiles (lock) Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory. true boolean readLockIdempotentReleaseAsync (lock) Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option. false boolean readLockIdempotentReleaseAsyncPoolSize (lock) The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option. int readLockIdempotentReleaseDelay (lock) Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true. int readLockIdempotentReleaseExecutorService (lock) To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option. ScheduledExecutorService readLockLoggingLevel (lock) Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename. Enum values: TRACE DEBUG INFO WARN ERROR OFF DEBUG LoggingLevel readLockMarkerFile (lock) Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. true boolean readLockMinAge (lock) This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. 0 long readLockMinLength (lock) This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. 1 long readLockRemoveOnCommit (lock) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option. false boolean readLockRemoveOnRollback (lock) This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit). true boolean readLockTimeout (lock) Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. 10000 long backoffErrorThreshold (scheduler) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. int backoffIdleThreshold (scheduler) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. int backoffMultiplier (scheduler) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. int delay (scheduler) Milliseconds before the poll. 500 long greedy (scheduler) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the run polled 1 or more messages. false boolean initialDelay (scheduler) Milliseconds before the first poll starts. 1000 long repeatCount (scheduler) Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. 0 long runLoggingLevel (scheduler) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. Enum values: TRACE DEBUG INFO WARN ERROR OFF TRACE LoggingLevel scheduledExecutorService (scheduler) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. ScheduledExecutorService scheduler (scheduler) To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. none Object schedulerProperties (scheduler) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. Map startScheduler (scheduler) Whether the scheduler should be auto started. true boolean timeUnit (scheduler) Time unit for initialDelay and delay options. Enum values: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS MILLISECONDS TimeUnit useFixedDelay (scheduler) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. true boolean shuffle (sort) To shuffle the list of files (sort in random order). false boolean sortBy (sort) Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. String sorter (sort) Pluggable sorter as a java.util.Comparator class. Comparator Note Default behavior for file producer By default it will override any existing file, if one exist with the same name. 34.6. Move and Delete operations Any move or delete operations is executed after (post command) the routing has completed; so during processing of the Exchange the file is still located in the inbox folder. Lets illustrate this with an example: from("file://inbox?move=.done").to("bean:handleOrder"); When a file is dropped in the inbox folder, the file consumer notices this and creates a new FileExchange that is routed to the handleOrder bean. The bean then processes the File object. At this point in time the file is still located in the inbox folder. After the bean completes, and thus the route is completed, the file consumer will perform the move operation and move the file to the .done sub-folder. The move and the preMove options are considered as a directory name (though if you use an expression such as File Language, or Simple then the result of the expression evaluation is the file name to be used. For example, if you set: then that's using the File language which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed. By default, Camel will move consumed files to the .camel sub-folder relative to the directory where the file was consumed. If you want to delete the file after processing, the route should be: from("file://inbox?delete=true").to("bean:handleOrder"); We have introduced a pre move operation to move files before they are processed. This allows you to mark which files have been scanned as they are moved to this sub folder before being processed. from("file://inbox?preMove=inprogress").to("bean:handleOrder"); You can combine the pre move and the regular move: from("file://inbox?preMove=inprogress&move=.done").to("bean:handleOrder"); So in this situation, the file is in the inprogress folder when being processed and after it's processed, it's moved to the .done folder. 34.7. Fine grained control over Move and PreMove option The move and preMove options are Expression-based, so we have the full power of the File Language to do advanced configuration of the directory and name pattern. Camel will, in fact, internally convert the directory name you enter into a File Language expression. So when we enter move=.done Camel will convert this into: USD{file:parent}/.done/USD{file:onlyname} . This is only done if Camel detects that you have not provided a USD\{ } in the option value yourself. So when you enter a USD\{ } Camel will not convert it and thus you have the full power. So if we want to move the file into a backup folder with today's date as the pattern, we can do: 34.8. About moveFailed The moveFailed option allows you to move files that could not be processed successfully to another location such as an error folder of your choice. For example to move the files in an error folder with a timestamp you can use moveFailed=/error/USD{ file:name.noext }-USD{date:now:yyyyMMddHHmmssSSS}.USD{\'\'file:ext }. 34.9. Message Headers The following headers are supported by this component: 34.9.1. File producer only Header Description CamelFileName Specifies the name of the file to write (relative to the endpoint directory). This name can be a String ; a String with a File Language or Simple language expression; or an Expression object. If it's null then Camel will auto-generate a filename based on the message unique ID. CamelFileNameProduced The actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written. CamelOverruleFileName Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option fileName has been configured, then this is still being evaluated. 34.9.2. File consumer only Header Description CamelFileName Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint. CamelFileNameOnly Only the file name (the name with no leading paths). CamelFileAbsolute A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well. CamelFileAbsolutePath The absolute path to the file. For relative files this path holds the relative path instead. CamelFilePath The file path. For relative files this is the starting directory + the relative filename. For absolute files this is the absolute path. CamelFileRelativePath The relative path. CamelFileParent The parent path. CamelFileLength A long value containing the file size. CamelFileLastModified A Long value containing the last modified timestamp of the file. 34.10. Batch Consumer This component implements the Batch Consumer. 34.11. Exchange Properties, file consumer only As the file consumer implements the BatchConsumer it supports batching the files it polls. By batching we mean that Camel will add the following additional properties to the Exchange, so you know the number of files polled, the current index, and whether the batch is already completed. Property Description CamelBatchSize The total number of files that was polled in this batch. CamelBatchIndex The current index of the batch. Starts from 0. CamelBatchComplete A boolean value indicating the last Exchange in the batch. Is only true for the last entry. This allows you for instance to know how many files exist in this batch and for instance let the Aggregator2 aggregate this number of files. 34.12. Using charset The charset option allows for configuring an encoding of the files on both the consumer and producer endpoints. For example if you read utf-8 files, and want to convert the files to iso-8859-1, you can do: from("file:inbox?charset=utf-8") .to("file:outbox?charset=iso-8859-1") You can also use the convertBodyTo in the route. In the example below we have still input files in utf-8 format, but we want to convert the file content to a byte array in iso-8859-1 format. And then let a bean process the data. Before writing the content to the outbox folder using the current charset. from("file:inbox?charset=utf-8") .convertBodyTo(byte[].class, "iso-8859-1") .to("bean:myBean") .to("file:outbox"); If you omit the charset on the consumer endpoint, then Camel does not know the charset of the file, and would by default use "UTF-8". However you can configure a JVM system property to override and use a different default encoding with the key org.apache.camel.default.charset . In the example below this could be a problem if the files is not in UTF-8 encoding, which would be the default encoding for read the files. In this example when writing the files, the content has already been converted to a byte array, and thus would write the content directly as is (without any further encodings). from("file:inbox") .convertBodyTo(byte[].class, "iso-8859-1") .to("bean:myBean") .to("file:outbox"); You can also override and control the encoding dynamic when writing files, by setting a property on the exchange with the key Exchange.CHARSET_NAME . For example in the route below we set the property with a value from a message header. from("file:inbox") .convertBodyTo(byte[].class, "iso-8859-1") .to("bean:myBean") .setProperty(Exchange.CHARSET_NAME, header("someCharsetHeader")) .to("file:outbox"); We suggest to keep things simpler, so if you pickup files with the same encoding, and want to write the files in a specific encoding, then favor to use the charset option on the endpoints. Notice that if you have explicit configured a charset option on the endpoint, then that configuration is used, regardless of the Exchange.CHARSET_NAME property. If you have some issues then you can enable DEBUG logging on org.apache.camel.component.file , and Camel logs when it reads/write a file using a specific charset. For example the route below will log the following: from("file:inbox?charset=utf-8") .to("file:outbox?charset=iso-8859-1") And the logs: 34.13. Common gotchas with folder and filenames When Camel is producing files (writing files) there are a few gotchas affecting how to set a filename of your choice. By default, Camel will use the message ID as the filename, and since the message ID is normally a unique generated ID, you will end up with filenames such as: ID-MACHINENAME-2443-1211718892437-1-0 . If such a filename is not desired, then you must provide a filename in the CamelFileName message header. The constant, Exchange.FILE_NAME , can also be used. The sample code below produces files using the message ID as the filename: from("direct:report").to("file:target/reports"); To use report.txt as the filename you have to do: from("direct:report").setHeader(Exchange.FILE_NAME, constant("report.txt")).to( "file:target/reports"); the same as above, but with CamelFileName : from("direct:report").setHeader("CamelFileName", constant("report.txt")).to( "file:target/reports"); And a syntax where we set the filename on the endpoint with the fileName URI option. from("direct:report").to("file:target/reports/?fileName=report.txt"); 34.14. Filename Expression Filename can be set either using the expression option or as a string-based File language expression in the CamelFileName header. See the File language for syntax and samples. 34.15. Consuming files from folders where others drop files directly Beware if you consume files from a folder where other applications write files to directly. Take a look at the different readLock options to see what suits your use cases. The best approach is however to write to another folder and after the write move the file in the drop folder. However if you write files directly to the drop folder then the option changed could better detect whether a file is currently being written/copied as it uses a file changed algorithm to see whether the file size / modification changes over a period of time. The other readLock options rely on Java File API that sadly is not always very good at detecting this. You may also want to look at the doneFileName option, which uses a marker file (done file) to signal when a file is done and ready to be consumed. 34.16. Using done files See also section writing done files below. If you want only to consume files when a done file exists, then you can use the doneFileName option on the endpoint. from("file:bar?doneFileName=done"); Will only consume files from the bar folder, if a done file exists in the same directory as the target files. Camel will automatically delete the done file when it's done consuming the files. Camel does not delete automatically the done file if noop=true is configured. However it is more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the doneFileName option. Currently Camel supports the following two dynamic tokens: file:name and file:name.noext which must be enclosed in USD\{ }. The consumer only supports the static part of the done file name as either prefix or suffix (not both). from("file:bar?doneFileName=USD{file:name}.done"); In this example only files will be polled if there exists a done file with the name file name .done. For example hello.txt - is the file to be consumed hello.txt.done - is the associated done file You can also use a prefix for the done file, such as: from("file:bar?doneFileName=ready-USD{file:name}"); hello.txt - is the file to be consumed ready-hello.txt - is the associated done file 34.17. Writing done files After you have written a file you may want to write an additional done file as a kind of marker, to indicate to others that the file is finished and has been written. To do that you can use the doneFileName option on the file producer endpoint. .to("file:bar?doneFileName=done"); Will simply create a file named done in the same directory as the target file. However it is more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the doneFileName option. Currently Camel supports the following two dynamic tokens: file:name and file:name.noext which must be enclosed in USD\{ }. .to("file:bar?doneFileName=done-USD{file:name}"); Will for example create a file named done-foo.txt if the target file was foo.txt in the same directory as the target file. .to("file:bar?doneFileName=USD{file:name}.done"); Will for example create a file named foo.txt.done if the target file was foo.txt in the same directory as the target file. .to("file:bar?doneFileName=USD{file:name.noext}.done"); Will for example create a file named foo.done if the target file was foo.txt in the same directory as the target file. 34.18. Samples 34.18.1. Read from a directory and write to another directory from("file://inputdir/?delete=true").to("file://outputdir") 34.18.2. Read from a directory and write to another directory using a overrule dynamic name from("file://inputdir/?delete=true").to("file://outputdir?overruleFile=copy-of-USD{file:name}") Listen on a directory and create a message for each file dropped there. Copy the contents to the outputdir and delete the file in the inputdir . 34.18.3. Reading recursively from a directory and writing to another from("file://inputdir/?recursive=true&delete=true").to("file://outputdir") Listen on a directory and create a message for each file dropped there. Copy the contents to the outputdir and delete the file in the inputdir . Will scan recursively into sub-directories. Will lay out the files in the same directory structure in the outputdir as the inputdir , including any sub-directories. inputdir/foo.txt inputdir/sub/bar.txt Will result in the following output layout: 34.19. Using flatten If you want to store the files in the outputdir directory in the same directory, disregarding the source directory layout (e.g. to flatten out the path), you just add the flatten=true option on the file producer side: from("file://inputdir/?recursive=true&delete=true").to("file://outputdir?flatten=true") Will result in the following output layout: 34.20. Reading from a directory and the default move operation Camel will by default move any processed file into a .camel subdirectory in the directory the file was consumed from. from("file://inputdir/?recursive=true&delete=true").to("file://outputdir") Affects the layout as follows: before after 34.21. Read from a directory and process the message in java from("file://inputdir/").process(new Processor() { public void process(Exchange exchange) throws Exception { Object body = exchange.getIn().getBody(); // do some business logic with the input body } }); The body will be a File object that points to the file that was just dropped into the inputdir directory. 34.22. Writing to files Camel is of course also able to write files, i.e. produce files. In the sample below we receive some reports on the SEDA queue that we process before they are being written to a directory. 34.22.1. Write to subdirectory using Exchange.FILE_NAME Using a single route, it is possible to write a file to any number of subdirectories. If you have a route setup as such: <route> <from uri="bean:myBean"/> <to uri="file:/rootDirectory"/> </route> You can have myBean set the header Exchange.FILE_NAME to values such as: This allows you to have a single route to write files to multiple destinations. 34.22.2. Writing file through the temporary directory relative to the final destination Sometime you need to temporarily write the files to some directory relative to the destination directory. Such situation usually happens when some external process with limited filtering capabilities is reading from the directory you are writing to. In the example below files will be written to the /var/myapp/filesInProgress directory and after data transfer is done, they will be atomically moved to the` /var/myapp/finalDirectory `directory. from("direct:start"). to("file:///var/myapp/finalDirectory?tempPrefix=/../filesInProgress/"); 34.23. Using expression for filenames In this sample we want to move consumed files to a backup folder using today's date as a sub-folder name: from("file://inbox?move=backup/USD{date:now:yyyyMMdd}/USD{file:name}").to("..."); See File language for more samples. 34.24. Avoiding reading the same file more than once (idempotent consumer) Camel supports Idempotent Consumer directly within the component so it will skip already processed files. This feature can be enabled by setting the idempotent=true option. from("file://inbox?idempotent=true").to("..."); Camel uses the absolute file name as the idempotent key, to detect duplicate files. You can customize this key by using an expression in the idempotentKey option. For example to use both the name and the file size as the key <route> <from uri="file://inbox?idempotent=true&amp;idempotentKey=USD{file:name}-USD{file:size}"/> <to uri="bean:processInbox"/> </route> By default Camel uses a in memory based store for keeping track of consumed files, it uses a least recently used cache holding up to 1000 entries. You can plugin your own implementation of this store by using the idempotentRepository option using the # sign in the value to indicate it's a referring to a bean in the Registry with the specified id . <!-- define our store as a plain spring bean --> <bean id="myStore" class="com.mycompany.MyIdempotentStore"/> <route> <from uri="file://inbox?idempotent=true&amp;idempotentRepository=#myStore"/> <to uri="bean:processInbox"/> </route> Camel will log at DEBUG level if it skips a file because it has been consumed before: DEBUG FileConsumer is idempotent and the file has been consumed before. Will skip this file: target\idempotent\report.txt 34.25. Using a file based idempotent repository In this section we will use the file based idempotent repository org.apache.camel.processor.idempotent.FileIdempotentRepository instead of the in-memory based that is used as default. This repository uses a 1st level cache to avoid reading the file repository. It will only use the file repository to store the content of the 1st level cache. Thereby the repository can survive server restarts. It will load the content of the file into the 1st level cache upon startup. The file structure is very simple as it stores the key in separate lines in the file. By default, the file store has a size limit of 1mb. When the file grows larger Camel will truncate the file store, rebuilding the content by flushing the 1st level cache into a fresh empty file. We configure our repository using Spring XML creating our file idempotent repository and define our file consumer to use our repository with the idempotentRepository using # sign to indicate Registry lookup: 34.26. Using a JPA based idempotent repository In this section we will use the JPA based idempotent repository instead of the in-memory based that is used as default. First we need a persistence-unit in META-INF/persistence.xml where we need to use the class org.apache.camel.processor.idempotent.jpa.MessageProcessed as model. <persistence-unit name="idempotentDb" transaction-type="RESOURCE_LOCAL"> <class>org.apache.camel.processor.idempotent.jpa.MessageProcessed</class> <properties> <property name="openjpa.ConnectionURL" value="jdbc:derby:target/idempotentTest;create=true"/> <property name="openjpa.ConnectionDriverName" value="org.apache.derby.jdbc.EmbeddedDriver"/> <property name="openjpa.jdbc.SynchronizeMappings" value="buildSchema"/> <property name="openjpa.Log" value="DefaultLevel=WARN, Tool=INFO"/> <property name="openjpa.Multithreaded" value="true"/> </properties> </persistence-unit> , we can create our JPA idempotent repository in the spring XML file as well: <!-- we define our jpa based idempotent repository we want to use in the file consumer --> <bean id="jpaStore" class="org.apache.camel.processor.idempotent.jpa.JpaMessageIdRepository"> <!-- Here we refer to the entityManagerFactory --> <constructor-arg index="0" ref="entityManagerFactory"/> <!-- This 2nd parameter is the name (= a category name). You can have different repositories with different names --> <constructor-arg index="1" value="FileConsumer"/> </bean> And yes then we just need to refer to the jpaStore bean in the file consumer endpoint using the idempotentRepository using the # syntax option: <route> <from uri="file://inbox?idempotent=true&amp;idempotentRepository=#jpaStore"/> <to uri="bean:processInbox"/> </route> 34.27. Filter using org.apache.camel.component.file.GenericFileFilter Camel supports pluggable filtering strategies. You can then configure the endpoint with such a filter to skip certain files being processed. In the sample we have built our own filter that skips files starting with skip in the filename: And then we can configure our route using the filter attribute to reference our filter (using # notation) that we have defined in the spring XML file: <!-- define our filter as a plain spring bean --> <bean id="myFilter" class="com.mycompany.MyFileFilter"/> <route> <from uri="file://inbox?filter=#myFilter"/> <to uri="bean:processInbox"/> </route> 34.28. Filtering using ANT path matcher The ANT path matcher is based on AntPathMatcher . The file paths is matched with the following rules: ? matches one character * matches zero or more characters ** matches zero or more directories in a path The antInclude and antExclude options make it easy to specify ANT style include/exclude without having to define the filter. See the URI options above for more information. The sample below demonstrates how to use it. Note When using minDepth/maxDepth with the combination of recursive=true , antExclude=... , and readLockDeleteOrphanLockFiles=true results in scanning all the files/subfolders deeper than value mentioned in the maxDepth . The workaround is to configure readLockDeleteOrphanLockFiles=false . 34.28.1. Sorting using Comparator Camel supports pluggable sorting strategies. This strategy it to use the build in java.util.Comparator in Java. You can then configure the endpoint with such a comparator and have Camel sort the files before being processed. In the sample we have built our own comparator that just sorts by file name: And then we can configure our route using the sorter option to reference to our sorter ( mySorter ) we have defined in the spring XML file: <!-- define our sorter as a plain spring bean --> <bean id="mySorter" class="com.mycompany.MyFileSorter"/> <route> <from uri="file://inbox?sorter=#mySorter"/> <to uri="bean:processInbox"/> </route> Note URI options can reference beans using the # syntax In the Spring DSL route above notice that we can refer to beans in the Registry by prefixing the id with #. So writing sorter=#mySorter , will instruct Camel to go look in the Registry for a bean with the ID, mySorter . 34.28.2. Sorting using sortBy Camel supports pluggable sorting strategies. This strategy it to use the File language to configure the sorting. The sortBy option is configured as follows: sortBy=group 1;group 2;group 3;... Where each group is separated with semi colon. In the simple situations you just use one group, so a simple example could be: This will sort by file name, you can reverse the order by prefixing reverse: to the group, so the sorting is now Z..A: As we have the full power of File language we can use some of the other parameters, so if we want to sort by file size we do: You can configure to ignore the case, using ignoreCase: for string comparison, so if you want to use file name sorting but to ignore the case then we do: You can combine ignore case and reverse, however reverse must be specified first: In the sample below we want to sort by last modified file, so we do: And then we want to group by name as a 2nd option so files with same modifcation is sorted by name: Now there is an issue here, can you spot it? Well the modified timestamp of the file is too fine as it will be in milliseconds, but what if we want to sort by date only and then subgroup by name? Well as we have the true power of File language we can use its date command that supports patterns. So this can be solved as: Yeah, that is pretty powerful, oh by the way you can also use reverse per group, so we could reverse the file names: 34.29. Using GenericFileProcessStrategy The option processStrategy can be used to use a custom GenericFileProcessStrategy that allows you to implement your own begin , commit and rollback logic. For instance lets assume a system writes a file in a folder you should consume. But you should not start consuming the file before another ready file has been written as well. So by implementing our own GenericFileProcessStrategy we can implement this as: In the begin() method we can test whether the special ready file exists. The begin method returns a boolean to indicate if we can consume the file or not. In the abort() method special logic can be executed in case the begin operation returned false , for example to cleanup resources etc. in the commit() method we can move the actual file and also delete the ready file. 34.30. Using filter The filter option allows you to implement a custom filter in Java code by implementing the org.apache.camel.component.file.GenericFileFilter interface. This interface has an accept method that returns a boolean. Return true to include the file, and false to skip the file. There is a isDirectory method on GenericFile whether the file is a directory. This allows you to filter unwanted directories, to avoid traversing down unwanted directories. For example to skip any directories which starts with "skip" in the name, can be implemented as follows: 34.31. Using bridgeErrorHandler If you want to use the Camel Error Handler to deal with any exception occurring in the file consumer, then you can enable the bridgeErrorHandler option as shown below: // to handle any IOException being thrown onException(IOException.class) .handled(true) .log("IOException occurred due: USD{exception.message}") .transform().simple("Error USD{exception.message}") .to("mock:error"); // this is the file route that pickup files, notice how we bridge the consumer to use the Camel routing error handler // the exclusiveReadLockStrategy is only configured because this is from an unit test, so we use that to simulate exceptions from("file:target/nospace?bridgeErrorHandler=true") .convertBodyTo(String.class) .to("mock:result"); So all you have to do is to enable this option, and the error handler in the route will take it from there. Important When using bridgeErrorHandler When using bridgeErrorHandler, then interceptors, OnCompletions does not apply. The Exchange is processed directly by the Camel Error Handler, and does not allow prior actions such as interceptors, onCompletion to take action. 34.32. Debug logging This component has log level TRACE that can be helpful if you have problems. 34.33. Spring Boot Auto-Configuration The component supports 11 options, which are listed below. Name Description Default Type camel.cluster.file.acquire-lock-delay The time to wait before starting to try to acquire lock. String camel.cluster.file.acquire-lock-interval The time to wait between attempts to try to acquire lock. String camel.cluster.file.attributes Custom service attributes. Map camel.cluster.file.enabled Sets if the file cluster service should be enabled or not, default is false. false Boolean camel.cluster.file.id Cluster Service ID. String camel.cluster.file.order Service lookup order/priority. Integer camel.cluster.file.root The root path. String camel.component.file.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.file.bridge-error-handler Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false Boolean camel.component.file.enabled Whether to enable auto configuration of the file component. This is enabled by default. Boolean camel.component.file.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean
[ "<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-file-starter</artifactId> </dependency>", "file:directoryName[?options]", "file:directoryName", "from(\"file://inbox?move=.done\").to(\"bean:handleOrder\");", "move=../backup/copy-of-USD{file:name}", "from(\"file://inbox?delete=true\").to(\"bean:handleOrder\");", "from(\"file://inbox?preMove=inprogress\").to(\"bean:handleOrder\");", "from(\"file://inbox?preMove=inprogress&move=.done\").to(\"bean:handleOrder\");", "move=backup/USD{date:now:yyyyMMdd}/USD{file:name}", "from(\"file:inbox?charset=utf-8\") .to(\"file:outbox?charset=iso-8859-1\")", "from(\"file:inbox?charset=utf-8\") .convertBodyTo(byte[].class, \"iso-8859-1\") .to(\"bean:myBean\") .to(\"file:outbox\");", "from(\"file:inbox\") .convertBodyTo(byte[].class, \"iso-8859-1\") .to(\"bean:myBean\") .to(\"file:outbox\");", "from(\"file:inbox\") .convertBodyTo(byte[].class, \"iso-8859-1\") .to(\"bean:myBean\") .setProperty(Exchange.CHARSET_NAME, header(\"someCharsetHeader\")) .to(\"file:outbox\");", "from(\"file:inbox?charset=utf-8\") .to(\"file:outbox?charset=iso-8859-1\")", "DEBUG GenericFileConverter - Read file /Users/davsclaus/workspace/camel/camel-core/target/charset/input/input.txt with charset utf-8 DEBUG FileOperations - Using Reader to write file: target/charset/output.txt with charset: iso-8859-1", "from(\"direct:report\").to(\"file:target/reports\");", "from(\"direct:report\").setHeader(Exchange.FILE_NAME, constant(\"report.txt\")).to( \"file:target/reports\");", "from(\"direct:report\").setHeader(\"CamelFileName\", constant(\"report.txt\")).to( \"file:target/reports\");", "from(\"direct:report\").to(\"file:target/reports/?fileName=report.txt\");", "from(\"file:bar?doneFileName=done\");", "from(\"file:bar?doneFileName=USD{file:name}.done\");", "from(\"file:bar?doneFileName=ready-USD{file:name}\");", ".to(\"file:bar?doneFileName=done\");", ".to(\"file:bar?doneFileName=done-USD{file:name}\");", ".to(\"file:bar?doneFileName=USD{file:name}.done\");", ".to(\"file:bar?doneFileName=USD{file:name.noext}.done\");", "from(\"file://inputdir/?delete=true\").to(\"file://outputdir\")", "from(\"file://inputdir/?delete=true\").to(\"file://outputdir?overruleFile=copy-of-USD{file:name}\")", "from(\"file://inputdir/?recursive=true&delete=true\").to(\"file://outputdir\")", "inputdir/foo.txt inputdir/sub/bar.txt", "outputdir/foo.txt outputdir/sub/bar.txt", "from(\"file://inputdir/?recursive=true&delete=true\").to(\"file://outputdir?flatten=true\")", "outputdir/foo.txt outputdir/bar.txt", "from(\"file://inputdir/?recursive=true&delete=true\").to(\"file://outputdir\")", "inputdir/foo.txt inputdir/sub/bar.txt", "inputdir/.camel/foo.txt inputdir/sub/.camel/bar.txt outputdir/foo.txt outputdir/sub/bar.txt", "from(\"file://inputdir/\").process(new Processor() { public void process(Exchange exchange) throws Exception { Object body = exchange.getIn().getBody(); // do some business logic with the input body } });", "<route> <from uri=\"bean:myBean\"/> <to uri=\"file:/rootDirectory\"/> </route>", "Exchange.FILE_NAME = hello.txt => /rootDirectory/hello.txt Exchange.FILE_NAME = foo/bye.txt => /rootDirectory/foo/bye.txt", "from(\"direct:start\"). to(\"file:///var/myapp/finalDirectory?tempPrefix=/../filesInProgress/\");", "from(\"file://inbox?move=backup/USD{date:now:yyyyMMdd}/USD{file:name}\").to(\"...\");", "from(\"file://inbox?idempotent=true\").to(\"...\");", "<route> <from uri=\"file://inbox?idempotent=true&amp;idempotentKey=USD{file:name}-USD{file:size}\"/> <to uri=\"bean:processInbox\"/> </route>", "<!-- define our store as a plain spring bean --> <bean id=\"myStore\" class=\"com.mycompany.MyIdempotentStore\"/> <route> <from uri=\"file://inbox?idempotent=true&amp;idempotentRepository=#myStore\"/> <to uri=\"bean:processInbox\"/> </route>", "DEBUG FileConsumer is idempotent and the file has been consumed before. Will skip this file: target\\idempotent\\report.txt", "<persistence-unit name=\"idempotentDb\" transaction-type=\"RESOURCE_LOCAL\"> <class>org.apache.camel.processor.idempotent.jpa.MessageProcessed</class> <properties> <property name=\"openjpa.ConnectionURL\" value=\"jdbc:derby:target/idempotentTest;create=true\"/> <property name=\"openjpa.ConnectionDriverName\" value=\"org.apache.derby.jdbc.EmbeddedDriver\"/> <property name=\"openjpa.jdbc.SynchronizeMappings\" value=\"buildSchema\"/> <property name=\"openjpa.Log\" value=\"DefaultLevel=WARN, Tool=INFO\"/> <property name=\"openjpa.Multithreaded\" value=\"true\"/> </properties> </persistence-unit>", "<!-- we define our jpa based idempotent repository we want to use in the file consumer --> <bean id=\"jpaStore\" class=\"org.apache.camel.processor.idempotent.jpa.JpaMessageIdRepository\"> <!-- Here we refer to the entityManagerFactory --> <constructor-arg index=\"0\" ref=\"entityManagerFactory\"/> <!-- This 2nd parameter is the name (= a category name). You can have different repositories with different names --> <constructor-arg index=\"1\" value=\"FileConsumer\"/> </bean>", "<route> <from uri=\"file://inbox?idempotent=true&amp;idempotentRepository=#jpaStore\"/> <to uri=\"bean:processInbox\"/> </route>", "<!-- define our filter as a plain spring bean --> <bean id=\"myFilter\" class=\"com.mycompany.MyFileFilter\"/> <route> <from uri=\"file://inbox?filter=#myFilter\"/> <to uri=\"bean:processInbox\"/> </route>", "<!-- define our sorter as a plain spring bean --> <bean id=\"mySorter\" class=\"com.mycompany.MyFileSorter\"/> <route> <from uri=\"file://inbox?sorter=#mySorter\"/> <to uri=\"bean:processInbox\"/> </route>", "sortBy=group 1;group 2;group 3;", "sortBy=file:name", "sortBy=reverse:file:name", "sortBy=file:length", "sortBy=ignoreCase:file:name", "sortBy=reverse:ignoreCase:file:name", "sortBy=file:modified", "sortBy=file:modified;file:name", "sortBy=date:file:yyyyMMdd;file:name", "sortBy=date:file:yyyyMMdd;reverse:file:name", "// to handle any IOException being thrown onException(IOException.class) .handled(true) .log(\"IOException occurred due: USD{exception.message}\") .transform().simple(\"Error USD{exception.message}\") .to(\"mock:error\"); // this is the file route that pickup files, notice how we bridge the consumer to use the Camel routing error handler // the exclusiveReadLockStrategy is only configured because this is from an unit test, so we use that to simulate exceptions from(\"file:target/nospace?bridgeErrorHandler=true\") .convertBodyTo(String.class) .to(\"mock:result\");" ]
https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.4/html/red_hat_build_of_apache_camel_for_spring_boot_reference/csb-camel-file-component-starter
Chapter 4. Monitoring OVN
Chapter 4. Monitoring OVN You can use the ovn-trace command to monitor and troubleshoot OVN logical flows, and you can use the ovs-ofctl dump-flows command to monitor and troubleshoot OpenFlows. 4.1. Monitoring OVN logical flows OVN uses logical flows that are tables of flows with a priority, match, and actions. These logical flows are distributed to the ovn-controller running on each Compute node. You can use the ovn-sbctl lflow-list command on the Controller node to view the full set of logical flows, as shown in this example. Key differences between OVN and OpenFlow include: OVN ports are logical entities that reside somewhere on a network, not physical ports on a single switch. OVN gives each table in the pipeline a name in addition to its number. The name describes the purpose of that stage in the pipeline. The OVN match syntax supports complex Boolean expressions. The actions supported in OVN logical flows extend beyond those of OpenFlow. You can implement higher level features, such as DHCP, in the OVN logical flow syntax. ovn-trace The ovn-trace command can simulate how a packet travels through the OVN logical flows, or help you determine why a packet is dropped. Provide the ovn-trace command with the following parameters: DATAPATH The logical switch or logical router where the simulated packet starts. MICROFLOW The simulated packet, in the syntax used by the ovn-sb database. This example displays the --minimal output option on a simulated packet and shows that the packet reaches its destination: In more detail, the --summary output for this same simulated packet shows the full execution pipeline: The example output shows: The packet enters the sw0 network from the sw0-port1 port and runs the ingress pipeline. The outport variable is set to sw0-port2 indicating that the intended destination for this packet is sw0-port2 . The packet is output from the ingress pipeline, which brings it to the egress pipeline for sw0 with the outport variable set to sw0-port2 . The output action is executed in the egress pipeline, which outputs the packet to the current value of the outport variable, which is sw0-port2 . See the ovn-trace man page for complete details. 4.2. Monitoring OpenFlows You can use ovs-ofctl dump-flows command to monitor the OpenFlow flows on a logical switch in your network.
[ "ovn-sbctl --db=tcp:172.17.1.10:6642 lflow-list Datapath: \"sw0\" (d7bf4a7b-e915-4502-8f9d-5995d33f5d10) Pipeline: ingress table=0 (ls_in_port_sec_l2 ), priority=100 , match=(eth.src[40]), action=(drop;) table=0 (ls_in_port_sec_l2 ), priority=100 , match=(vlan.present), action=(drop;) table=0 (ls_in_port_sec_l2 ), priority=50 , match=(inport == \"sw0-port1\" && eth.src == {00:00:00:00:00:01}), action=(next;) table=0 (ls_in_port_sec_l2 ), priority=50 , match=(inport == \"sw0-port2\" && eth.src == {00:00:00:00:00:02}), action=(next;) table=1 (ls_in_port_sec_ip ), priority=0 , match=(1), action=(next;) table=2 (ls_in_port_sec_nd ), priority=90 , match=(inport == \"sw0-port1\" && eth.src == 00:00:00:00:00:01 && arp.sha == 00:00:00:00:00:01), action=(next;) table=2 (ls_in_port_sec_nd ), priority=90 , match=(inport == \"sw0-port1\" && eth.src == 00:00:00:00:00:01 && ip6 && nd && ((nd.sll == 00:00:00:00:00:00 || nd.sll == 00:00:00:00:00:01) || ((nd.tll == 00:00:00:00:00:00 || nd.tll == 00:00:00:00:00:01)))), action=(next;) table=2 (ls_in_port_sec_nd ), priority=90 , match=(inport == \"sw0-port2\" && eth.src == 00:00:00:00:00:02 && arp.sha == 00:00:00:00:00:02), action=(next;) table=2 (ls_in_port_sec_nd ), priority=90 , match=(inport == \"sw0-port2\" && eth.src == 00:00:00:00:00:02 && ip6 && nd && ((nd.sll == 00:00:00:00:00:00 || nd.sll == 00:00:00:00:00:02) || ((nd.tll == 00:00:00:00:00:00 || nd.tll == 00:00:00:00:00:02)))), action=(next;) table=2 (ls_in_port_sec_nd ), priority=80 , match=(inport == \"sw0-port1\" && (arp || nd)), action=(drop;) table=2 (ls_in_port_sec_nd ), priority=80 , match=(inport == \"sw0-port2\" && (arp || nd)), action=(drop;) table=2 (ls_in_port_sec_nd ), priority=0 , match=(1), action=(next;) table=3 (ls_in_pre_acl ), priority=0 , match=(1), action=(next;) table=4 (ls_in_pre_lb ), priority=0 , match=(1), action=(next;) table=5 (ls_in_pre_stateful ), priority=100 , match=(reg0[0] == 1), action=(ct_next;) table=5 (ls_in_pre_stateful ), priority=0 , match=(1), action=(next;) table=6 (ls_in_acl ), priority=0 , match=(1), action=(next;) table=7 (ls_in_qos_mark ), priority=0 , match=(1), action=(next;) table=8 (ls_in_lb ), priority=0 , match=(1), action=(next;) table=9 (ls_in_stateful ), priority=100 , match=(reg0[1] == 1), action=(ct_commit(ct_label=0/1); next;) table=9 (ls_in_stateful ), priority=100 , match=(reg0[2] == 1), action=(ct_lb;) table=9 (ls_in_stateful ), priority=0 , match=(1), action=(next;) table=10(ls_in_arp_rsp ), priority=0 , match=(1), action=(next;) table=11(ls_in_dhcp_options ), priority=0 , match=(1), action=(next;) table=12(ls_in_dhcp_response), priority=0 , match=(1), action=(next;) table=13(ls_in_l2_lkup ), priority=100 , match=(eth.mcast), action=(outport = \"_MC_flood\"; output;) table=13(ls_in_l2_lkup ), priority=50 , match=(eth.dst == 00:00:00:00:00:01), action=(outport = \"sw0-port1\"; output;) table=13(ls_in_l2_lkup ), priority=50 , match=(eth.dst == 00:00:00:00:00:02), action=(outport = \"sw0-port2\"; output;) Datapath: \"sw0\" (d7bf4a7b-e915-4502-8f9d-5995d33f5d10) Pipeline: egress table=0 (ls_out_pre_lb ), priority=0 , match=(1), action=(next;) table=1 (ls_out_pre_acl ), priority=0 , match=(1), action=(next;) table=2 (ls_out_pre_stateful), priority=100 , match=(reg0[0] == 1), action=(ct_next;) table=2 (ls_out_pre_stateful), priority=0 , match=(1), action=(next;) table=3 (ls_out_lb ), priority=0 , match=(1), action=(next;) table=4 (ls_out_acl ), priority=0 , match=(1), action=(next;) table=5 (ls_out_qos_mark ), priority=0 , match=(1), action=(next;) table=6 (ls_out_stateful ), priority=100 , match=(reg0[1] == 1), action=(ct_commit(ct_label=0/1); next;) table=6 (ls_out_stateful ), priority=100 , match=(reg0[2] == 1), action=(ct_lb;) table=6 (ls_out_stateful ), priority=0 , match=(1), action=(next;) table=7 (ls_out_port_sec_ip ), priority=0 , match=(1), action=(next;) table=8 (ls_out_port_sec_l2 ), priority=100 , match=(eth.mcast), action=(output;) table=8 (ls_out_port_sec_l2 ), priority=50 , match=(outport == \"sw0-port1\" && eth.dst == {00:00:00:00:00:01}), action=(output;) table=8 (ls_out_port_sec_l2 ), priority=50 , match=(outport == \"sw0-port2\" && eth.dst == {00:00:00:00:00:02}), action=(output;)", "ovn-trace --minimal sw0 'inport == \"sw0-port1\" && eth.src == 00:00:00:00:00:01 && eth.dst == 00:00:00:00:00:02' # reg14=0x1,vlan_tci=0x0000,dl_src=00:00:00:00:00:01,dl_dst=00:00:00:00:00:02,dl_type=0x0000 output(\"sw0-port2\");", "ovn-trace --summary sw0 'inport == \"sw0-port1\" && eth.src == 00:00:00:00:00:01 && eth.dst == 00:00:00:00:00:02' reg14=0x1,vlan_tci=0x0000,dl_src=00:00:00:00:00:01,dl_dst=00:00:00:00:00:02,dl_type=0x0000 ingress(dp=\"sw0\", inport=\"sw0-port1\") { outport = \"sw0-port2\"; output; egress(dp=\"sw0\", inport=\"sw0-port1\", outport=\"sw0-port2\") { output; /* output to \"sw0-port2\", type \"\" */; }; };", "ovs-ofctl dump-flows br-int NXST_FLOW reply (xid=0x4): cookie=0x0, duration=72.132s, table=0, n_packets=0, n_bytes=0, idle_age=72, priority=10,in_port=1,dl_src=00:00:00:00:00:01 actions=resubmit(,1) cookie=0x0, duration=60.565s, table=0, n_packets=0, n_bytes=0, idle_age=60, priority=10,in_port=2,dl_src=00:00:00:00:00:02 actions=resubmit(,1) cookie=0x0, duration=28.127s, table=0, n_packets=0, n_bytes=0, idle_age=28, priority=0 actions=drop cookie=0x0, duration=13.887s, table=1, n_packets=0, n_bytes=0, idle_age=13, priority=0,in_port=1 actions=output:2 cookie=0x0, duration=4.023s, table=1, n_packets=0, n_bytes=0, idle_age=4, priority=0,in_port=2 actions=output:1" ]
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.0/html/networking_with_open_virtual_network/monitoring_ovn
6.11. Listing Available Cluster Services and Resources
6.11. Listing Available Cluster Services and Resources You can use the ccs command to print a list of resources and services that are available for a cluster. You can also use the ccs command to print a list of the options you can specify for a particular service or resource type. To print a list of cluster services currently available for your cluster, execute either of the following commands ( --lsresourceopts is an alias to --lsserviceopts ): For example, the following command lists the cluster services and resources available on the cluster node node1 , showing sample output. To print a list of the options you can specify for a particular service type, execute the following command: For example, the following command lists the service options for the vm service.
[ "ccs -h host --lsserviceopts ccs -h host --lsresourceopts", "ccs -h node1 --lsserviceopts service - Defines a service (resource group). ASEHAagent - Sybase ASE Failover Instance SAPDatabase - SAP database resource agent SAPInstance - SAP instance resource agent apache - Defines an Apache web server clusterfs - Defines a cluster file system mount. fs - Defines a file system mount. ip - This is an IP address. lvm - LVM Failover script mysql - Defines a MySQL database server named - Defines an instance of named server netfs - Defines an NFS/CIFS file system mount. nfsclient - Defines an NFS client. nfsexport - This defines an NFS export. nfsserver - This defines an NFS server resource. openldap - Defines an Open LDAP server oracledb - Oracle 10g Failover Instance orainstance - Oracle 10g Failover Instance oralistener - Oracle 10g Listener Instance postgres-8 - Defines a PostgreSQL server samba - Dynamic smbd/nmbd resource agent script - LSB-compliant init script as a clustered resource. tomcat-6 - Defines a Tomcat server vm - Defines a Virtual Machine action - Overrides resource action timings for a resource instance.", "ccs -h host --lsserviceopts service_type", "ccs -f node1 --lsserviceopts vm vm - Defines a Virtual Machine Required Options: name: Name Optional Options: domain: Cluster failover Domain autostart: Automatic start after quorum formation exclusive: Exclusive resource group recovery: Failure recovery policy migration_mapping: memberhost:targethost,memberhost:targethost .. use_virsh: If set to 1, vm.sh will use the virsh command to manage virtual machines instead of xm. This is required when using non-Xen virtual machines (e.g. qemu / KVM). xmlfile: Full path to libvirt XML file describing the domain. migrate: Migration type (live or pause, default = live). path: Path to virtual machine configuration files. snapshot: Path to the snapshot directory where the virtual machine image will be stored. depend: Top-level service this depends on, in service:name format. depend_mode: Service dependency mode (soft or hard). max_restarts: Maximum restarts for this service. restart_expire_time: Restart expiration time; amount of time before a restart is forgotten. status_program: Additional status check program hypervisor: Hypervisor hypervisor_uri: Hypervisor URI (normally automatic). migration_uri: Migration URI (normally automatic). __independent_subtree: Treat this and all children as an independent subtree. __enforce_timeouts: Consider a timeout for operations as fatal. __max_failures: Maximum number of failures before returning a failure to a status check. __failure_expire_time: Amount of time before a failure is forgotten. __max_restarts: Maximum number restarts for an independent subtree before giving up. __restart_expire_time: Amount of time before a failure is forgotten for an independent subtree." ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/cluster_administration/s1-list-services-ccs-CA
8.86. libXcursor
8.86. libXcursor 8.86.1. RHBA-2013:0906 - libXcursor bug fix update Updated libXcursor packages that fix one bug are now available for Red Hat Enterprise Linux 6. The X.Org's X11 libXcursor package provides a runtime library for cursor management, designed to help locate and load cursors. Bug Fix BZ#949586 In the last rebuild of libXcursor, the Icon Theme was changed to Adwaita, which was not available in Red Hat Enterprise Linux 6. To fix this bug, the Icon Theme has been changed back to dmz-aa for Red Hat Enterprise Linux 6. Users of libXcursor are advised to upgrade to these updated packages, which fix this bug.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.5_technical_notes/libxcursor
Hammer Cheat Sheet
Hammer Cheat Sheet Red Hat Satellite 6.11 Hammer CLI Cheat Sheet for Red Hat Satellite Red Hat Satellite Documentation Team [email protected]
null
https://docs.redhat.com/en/documentation/red_hat_satellite/6.11/html/hammer_cheat_sheet/index
Appendix B. Migrating Databases and Services to a Remote Server
Appendix B. Migrating Databases and Services to a Remote Server Although you cannot configure remote databases and services during the automated installation, you can migrate them to a separate server post-installation. B.1. Migrating the Self-Hosted Engine Database to a Remote Server You can migrate the engine database of a self-hosted engine to a remote database server after the Red Hat Virtualization Manager has been initially configured. Use engine-backup to create a database backup and restore it on the new database server. The new database server must have Red Hat Enterprise Linux 7 installed and the required repositories enabled: Enabling the Red Hat Virtualization Manager Repositories Register the system with Red Hat Subscription Manager, attach the Red Hat Virtualization Manager subscription, and enable Manager repositories. Procedure Register your system with the Content Delivery Network, entering your Customer Portal user name and password when prompted: Note If you are using an IPv6 network, use an IPv6 transition mechanism to access the Content Delivery Network and subscription manager. Find the Red Hat Virtualization Manager subscription pool and record the pool ID: Use the pool ID to attach the subscription to the system: Note To view currently attached subscriptions: To list all enabled repositories: Configure the repositories: Migrating the Self-Hosted Engine Database to a Remote Server Log in to a self-hosted engine node and place the environment into global maintenance mode. This disables the High Availability agents and prevents the Manager virtual machine from being migrated during the procedure: Log in to the Red Hat Virtualization Manager machine and stop the ovirt-engine service so that it does not interfere with the engine backup: Create the engine database backup: Copy the backup file to the new database server: Log in to the new database server and install engine-backup : Restore the database on the new database server. file_name is the backup file copied from the Manager. Now that the database has been migrated, start the ovirt-engine service: Log in to a self-hosted engine node and turn off maintenance mode, enabling the High Availability agents: B.2. Migrating Data Warehouse to a Separate Machine This section describes how to migrate the Data Warehouse database and service from the Red Hat Virtualization Manager to a separate machine. Hosting the Data Warehouse service on a separate machine reduces the load on each individual machine, and allows each service to avoid potential conflicts caused by sharing CPU and memory resources with other processes. You can migrate the Data Warehouse service and connect it with the existing Data Warehouse database ( ovirt_engine_history ), or you can migrate the Data Warehouse database to the separate machine before migrating the Data Warehouse service. If the Data Warehouse database is hosted on the Manager, migrating the database in addition to the Data Warehouse service further reduces the competition for resources on the Manager machine. You can migrate the database to the same machine onto which you will migrate the Data Warehouse service, or to a machine that is separate from both the Manager machine and the new Data Warehouse service machine. B.2.1. Migrating the Data Warehouse Database to a Separate Machine Migrate the Data Warehouse database ( ovirt_engine_history ) before you migrate the Data Warehouse service. Use engine-backup to create a database backup and restore it on the new database machine. For more information on engine-backup , run engine-backup --help . To migrate the Data Warehouse service only, see Section B.2.2, "Migrating the Data Warehouse Service to a Separate Machine" . The new database server must have Red Hat Enterprise Linux 7 installed. Enable the required repositories on the new database server. Enabling the Red Hat Virtualization Manager Repositories Register the system with Red Hat Subscription Manager, attach the Red Hat Virtualization Manager subscription, and enable Manager repositories. Procedure Register your system with the Content Delivery Network, entering your Customer Portal user name and password when prompted: Note If you are using an IPv6 network, use an IPv6 transition mechanism to access the Content Delivery Network and subscription manager. Find the Red Hat Virtualization Manager subscription pool and record the pool ID: Use the pool ID to attach the subscription to the system: Note To view currently attached subscriptions: To list all enabled repositories: Configure the repositories: Migrating the Data Warehouse Database to a Separate Machine Create a backup of the Data Warehouse database and configuration files on the Manager: Copy the backup file from the Manager to the new machine: Install engine-backup on the new machine: Install the PostgreSQL server package: Initialize the PostgreSQL database, start the postgresql service, and ensure that this service starts on boot: Restore the Data Warehouse database on the new machine. file_name is the backup file copied from the Manager. The Data Warehouse database is now hosted on a separate machine from that on which the Manager is hosted. After successfully restoring the Data Warehouse database, a prompt instructs you to run the engine-setup command. Before running this command, migrate the Data Warehouse service. B.2.2. Migrating the Data Warehouse Service to a Separate Machine You can migrate the Data Warehouse service installed and configured on the Red Hat Virtualization Manager to a separate machine. Hosting the Data Warehouse service on a separate machine helps to reduce the load on the Manager machine. Notice that this procedure migrates the Data Warehouse service only. To migrate the Data Warehouse database ( ovirt_engine_history ) prior to migrating the Data Warehouse service, see Section B.2.1, "Migrating the Data Warehouse Database to a Separate Machine" . Prerequisites You must have installed and configured the Manager and Data Warehouse on the same machine. To set up the new Data Warehouse machine, you must have the following: The password from the Manager's /etc/ovirt-engine/engine.conf.d/10-setup-database.conf file. Allowed access from the Data Warehouse machine to the Manager database machine's TCP port 5432. The username and password for the Data Warehouse database from the Manager's /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conf file. If you migrated the ovirt_engine_history database using Section B.2.1, "Migrating the Data Warehouse Database to a Separate Machine" , the backup includes these credentials, which you defined during the database setup on that machine. Installing this scenario requires four steps: Setting up the New Data Warehouse Machine Stopping the Data Warehouse service on the Manager machine Configuring the new Data Warehouse machine Disabling the Data Warehouse package on the Manager machine B.2.2.1. Setting up the New Data Warehouse Machine Enable the Red Hat Virtualization repositories and install the Data Warehouse setup package on a Red Hat Enterprise Linux 7 machine: Enable the required repositories: Register your system with the Content Delivery Network, entering your Customer Portal user name and password when prompted: Find the Red Hat Virtualization Manager subscription pool and record the pool ID: Use the pool ID to attach the subscription to the system: Configure the repositories: Ensure that all packages currently installed are up to date: Install the ovirt-engine-dwh-setup package: B.2.2.2. Stopping the Data Warehouse Service on the Manager Machine Stop the Data Warehouse service: If the database is hosted on a remote machine, you must manually grant access by editing the postgres.conf file. Edit the /var/opt/rh/rh-postgresql10/lib/pgsql/data/postgresql.conf file and modify the listen_addresses line so that it matches the following: If the line does not exist or has been commented out, add it manually. If the database is hosted on the Manager machine and was configured during a clean setup of the Red Hat Virtualization Manager, access is granted by default. See Section B.2.1, "Migrating the Data Warehouse Database to a Separate Machine" for more information on how to configure and migrate the Data Warehouse database. Restart the postgresql service: B.2.2.3. Configuring the New Data Warehouse Machine The order of the options or settings shown in this section may differ depending on your environment. If you are migrating both the ovirt_engine_history database and the Data Warehouse service to the same machine, run the following, otherwise proceed to the step. Run the engine-setup command to begin configuration of Data Warehouse on the machine: Press Enter to configure Data Warehouse: Press Enter to accept the automatically detected host name, or enter an alternative host name and press Enter : Press Enter to automatically configure the firewall, or type No and press Enter to maintain existing settings: If you choose to automatically configure the firewall, and no firewall managers are active, you are prompted to select your chosen firewall manager from a list of supported options. Type the name of the firewall manager and press Enter . This applies even in cases where only one option is listed. Enter the fully qualified domain name and password for the Manager. Press Enter to accept the default values in each other field: Enter the FQDN and password for the Manager database machine. Press Enter to accept the default values in each other field: Confirm your installation settings: The Data Warehouse service is now configured on the remote machine. Proceed to disable the Data Warehouse service on the Manager machine. B.2.2.4. Disabling the Data Warehouse Service on the Manager Machine On the Manager machine, restart the Manager: Run the following command to modify the file /etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf and set the options to False : Disable the Data Warehouse service: Remove the Data Warehouse files: The Data Warehouse service is now hosted on a separate machine from the Manager. B.3. Migrating the Websocket Proxy to a Separate Machine Important The websocket proxy and noVNC are Technology Preview features only. Technology Preview features are not supported with Red Hat production service-level agreements (SLAs) and might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information see Red Hat Technology Preview Features Support Scope . For security or performance reasons the websocket proxy can run on a separate machine that does not run the Red Hat Virtualization Manager. The procedure to migrate the websocket proxy from the Manager machine to a separate machine involves removing the websocket proxy configuration from the Manager machine, then installing the proxy on the separate machine. The engine-cleanup command can be used to remove the websocket proxy from the Manager machine: Removing the Websocket Proxy from the Manager machine On the Manager machine, run engine-cleanup to remove the required configuration. Type No when asked to remove all components and press Enter . Type No when asked to remove the engine and press Enter . Type Yes when asked to remove the websocket proxy and press Enter . Select No if asked to remove any other components. Installing a Websocket Proxy on a Separate Machine Important The websocket proxy and noVNC are Technology Preview features only. Technology Preview features are not supported with Red Hat production service-level agreements (SLAs) and might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information see Red Hat Technology Preview Features Support Scope . The websocket proxy allows users to connect to virtual machines through a noVNC console. The noVNC client uses websockets to pass VNC data. However, the VNC server in QEMU does not provide websocket support, so a websocket proxy must be placed between the client and the VNC server. The proxy can run on any machine that has access to the network, including the the Manager machine. For security and performance reasons, users may want to configure the websocket proxy on a separate machine. Procedure Install the websocket proxy: Run the engine-setup command to configure the websocket proxy. Note If the rhvm package has also been installed, choose No when asked to configure the Manager ( Engine ) on this host. Press Enter to allow engine-setup to configure a websocket proxy server on the machine. Press Enter to accept the automatically detected host name, or enter an alternative host name and press Enter . Note that the automatically detected host name may be incorrect if you are using virtual hosts: Press Enter to allow engine-setup to configure the firewall and open the ports required for external communication. If you do not allow engine-setup to modify your firewall configuration, then you must manually open the required ports. Enter the FQDN of the Manager machine and press Enter . Press Enter to allow engine-setup to perform actions on the Manager machine, or press 2 to manually perform the actions. Press Enter to accept the default SSH port number, or enter the port number of the Manager machine. Enter the root password to log in to the Manager machine and press Enter . Select whether to review iptables rules if they differ from the current settings. Press Enter to confirm the configuration settings. Instructions are provided to configure the Manager machine to use the configured websocket proxy. Log in to the Manager machine and execute the provided instructions.
[ "subscription-manager register", "subscription-manager list --available", "subscription-manager attach --pool= pool_id", "subscription-manager list --consumed", "yum repolist", "subscription-manager repos --disable='*' --enable=rhel-7-server-rpms --enable=rhel-7-server-supplementary-rpms --enable=rhel-7-server-rhv-4.3-manager-rpms --enable=rhel-7-server-rhv-4-manager-tools-rpms --enable=rhel-7-server-ansible-2.9-rpms --enable=jb-eap-7.2-for-rhel-7-server-rpms", "hosted-engine --set-maintenance --mode=global", "systemctl stop ovirt-engine.service", "engine-backup --scope=files --scope=db --mode=backup --file= file_name --log= backup_log_name", "scp /tmp/engine.dump [email protected]:/tmp", "yum install ovirt-engine-tools-backup", "engine-backup --mode=restore --scope=files --scope=db --file= file_name --log= restore_log_name --provision-db --no-restore-permissions", "systemctl start ovirt-engine.service", "hosted-engine --set-maintenance --mode=none", "subscription-manager register", "subscription-manager list --available", "subscription-manager attach --pool= pool_id", "subscription-manager list --consumed", "yum repolist", "subscription-manager repos --disable='*' --enable=rhel-7-server-rpms --enable=rhel-7-server-supplementary-rpms --enable=rhel-7-server-rhv-4.3-manager-rpms --enable=rhel-7-server-rhv-4-manager-tools-rpms --enable=rhel-7-server-ansible-2.9-rpms --enable=jb-eap-7.2-for-rhel-7-server-rpms", "engine-backup --mode=backup --scope=dwhdb --scope=files --file= file_name --log= log_file_name", "scp /tmp/file_name [email protected]:/tmp", "yum install ovirt-engine-tools-backup", "yum install rh-postgresql10 rh-postgresql10-postgresql-contrib", "scl enable rh-postgresql10 -- postgresql-setup --initdb systemctl enable rh-postgresql10-postgresql systemctl start rh-postgresql10-postgresql", "engine-backup --mode=restore --scope=files --scope=dwhdb --file= file_name --log= log_file_name --provision-dwh-db --no-restore-permissions", "subscription-manager register", "subscription-manager list --available", "subscription-manager attach --pool= pool_id", "subscription-manager repos --disable='*' --enable=rhel-7-server-rpms --enable=rhel-7-server-supplementary-rpms --enable=rhel-7-server-rhv-4.3-manager-rpms --enable=rhel-7-server-rhv-4-manager-tools-rpms --enable=rhel-7-server-ansible-2.9-rpms --enable=jb-eap-7.2-for-rhel-7-server-rpms", "yum update", "yum install ovirt-engine-dwh-setup", "systemctl stop ovirt-engine-dwhd.service", "listen_addresses = '*'", "systemctl restart rh-postgresql10-postgresql", "sed -i '/^ENGINE_DB_/d' /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conf sed -i -e 's;^\\(OVESETUP_ENGINE_CORE/enable=bool\\):True;\\1:False;' -e '/^OVESETUP_CONFIG\\/fqdn/d' /etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf", "engine-setup", "Configure Data Warehouse on this host (Yes, No) [Yes]:", "Host fully qualified DNS name of this server [ autodetected host name ]:", "Setup can automatically configure the firewall on this system. Note: automatic configuration of the firewall may overwrite current settings. Do you want Setup to configure the firewall? (Yes, No) [Yes]:", "Host fully qualified DNS name of the engine server []: engine-fqdn Setup needs to do some actions on the remote engine server. Either automatically, using ssh as root to access it, or you will be prompted to manually perform each such action. Please choose one of the following: 1 - Access remote engine server using ssh as root 2 - Perform each action manually, use files to copy content around (1, 2) [1]: ssh port on remote engine server [22]: root password on remote engine server engine-fqdn : password", "Engine database host []: manager-db-fqdn Engine database port [5432]: Engine database secured connection (Yes, No) [No]: Engine database name [engine]: Engine database user [engine]: Engine database password: password", "Please confirm installation settings (OK, Cancel) [OK]:", "service ovirt-engine restart", "sed -i -e 's;^\\(OVESETUP_DWH_CORE/enable=bool\\):True;\\1:False;' -e 's;^\\(OVESETUP_DWH_CONFIG/remoteEngineConfigured=bool\\):True;\\1:False;' /etc/ovirt-engine-setup.conf.d/20-setup-ovirt-post.conf", "systemctl disable ovirt-engine-dwhd.service", "rm -f /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/* .conf /var/lib/ovirt-engine-dwh/backups/*", "engine-cleanup", "Do you want to remove all components? (Yes, No) [Yes]: No", "Do you want to remove the engine? (Yes, No) [Yes]: No", "Do you want to remove the WebSocket proxy? (Yes, No) [No]: Yes", "yum install ovirt-engine-websocket-proxy", "engine-setup", "Configure WebSocket Proxy on this machine? (Yes, No) [Yes]:", "Host fully qualified DNS name of this server [ host.example.com ]:", "Setup can automatically configure the firewall on this system. Note: automatic configuration of the firewall may overwrite current settings. Do you want Setup to configure the firewall? (Yes, No) [Yes]:", "Host fully qualified DNS name of the engine server []: manager.example.com", "Setup will need to do some actions on the remote engine server. Either automatically, using ssh as root to access it, or you will be prompted to manually perform each such action. Please choose one of the following: 1 - Access remote engine server using ssh as root 2 - Perform each action manually, use files to copy content around (1, 2) [1]:", "ssh port on remote engine server [22]:", "root password on remote engine server engine_host.example.com :", "Generated iptables rules are different from current ones. Do you want to review them? (Yes, No) [No]:", "--== CONFIGURATION PREVIEW ==-- Firewall manager : iptables Update Firewall : True Host FQDN : host.example.com Configure WebSocket Proxy : True Engine Host FQDN : engine_host.example.com Please confirm installation settings (OK, Cancel) [OK]:", "Manual actions are required on the engine host in order to enroll certs for this host and configure the engine about it. Please execute this command on the engine host: engine-config -s WebSocketProxy=host.example.com:6100 and than restart the engine service to make it effective", "engine-config -s WebSocketProxy=host.example.com:6100 systemctl restart ovirt-engine.service" ]
https://docs.redhat.com/en/documentation/red_hat_virtualization/4.3/html/installing_red_hat_virtualization_as_a_self-hosted_engine_using_the_command_line/migrating_to_remote_servers_she_cli_deploy
Making open source more inclusive
Making open source more inclusive Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message .
null
https://docs.redhat.com/en/documentation/red_hat_amq/2021.q2/html/using_amq_streams_on_rhel/making-open-source-more-inclusive
8.6. Managed Resources
8.6. Managed Resources You can set a resource to unmanaged mode, which indicates that the resource is still in the configuration but Pacemaker does not manage the resource. The following command sets the indicated resources to unmanaged mode. The following command sets resources to managed mode, which is the default state. You can specify the name of a resource group with the pcs resource manage or pcs resource unmanage command. The command will act on all of the resources in the group, so that you can set all of the resources in a group to managed or unmanaged mode with a single command and then manage the contained resources individually.
[ "pcs resource unmanage resource1 [ resource2 ]", "pcs resource manage resource1 [ resource2 ]" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/high_availability_add-on_reference/s1-managedresource-HAAR
Using the AMQ Spring Boot Starter
Using the AMQ Spring Boot Starter Red Hat AMQ 2020.Q4 For Use with AMQ Clients 2.8
null
https://docs.redhat.com/en/documentation/red_hat_amq/2020.q4/html/using_the_amq_spring_boot_starter/index
5.9.6.2. Removing Storage
5.9.6.2. Removing Storage The process of removing storage from a Red Hat Enterprise Linux system is relatively straightforward. Here are the steps that are specific to Red Hat Enterprise Linux: Remove the disk drive's partitions from /etc/fstab Unmount the disk drive's active partitions Erase the contents of the disk drive The following sections cover these topics in more detail. 5.9.6.2.1. Remove the Disk Drive's Partitions From /etc/fstab Using the text editor of your choice, remove the line(s) corresponding to the disk drive's partition(s) from the /etc/fstab file. You can identify the proper lines by one of the following methods: Matching the partition's mount point against the directories in the second column of /etc/fstab Matching the device's file name against the file names in the first column of /etc/fstab Note Be sure to look for any lines in /etc/fstab that identify swap partitions on the disk drive to be removed; they can be easily overlooked.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/introduction_to_system_administration/s3-storage-removing
Providing feedback on Red Hat documentation
Providing feedback on Red Hat documentation We appreciate your input on our documentation. Tell us how we can make it better. Providing documentation feedback in Jira Use the Create Issue form to provide feedback on the documentation for Red Hat OpenStack Services on OpenShift (RHOSO) or earlier releases of Red Hat OpenStack Platform (RHOSP). When you create an issue for RHOSO or RHOSP documents, the issue is recorded in the RHOSO Jira project, where you can track the progress of your feedback. To complete the Create Issue form, ensure that you are logged in to Jira. If you do not have a Red Hat Jira account, you can create an account at https://issues.redhat.com . Click the following link to open a Create Issue page: Create Issue Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form. Click Create .
null
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.1/html/migrating_to_the_ovn_mechanism_driver/proc_providing-feedback-on-red-hat-documentation
Chapter 5. Using Jobs and DaemonSets
Chapter 5. Using Jobs and DaemonSets 5.1. Running background tasks on nodes automatically with daemon sets As an administrator, you can create and use daemon sets to run replicas of a pod on specific or all nodes in an OpenShift Container Platform cluster. A daemon set ensures that all (or some) nodes run a copy of a pod. As nodes are added to the cluster, pods are added to the cluster. As nodes are removed from the cluster, those pods are removed through garbage collection. Deleting a daemon set will clean up the pods it created. You can use daemon sets to create shared storage, run a logging pod on every node in your cluster, or deploy a monitoring agent on every node. For security reasons, the cluster administrators and the project administrators can create daemon sets. For more information on daemon sets, see the Kubernetes documentation . Important Daemon set scheduling is incompatible with project's default node selector. If you fail to disable it, the daemon set gets restricted by merging with the default node selector. This results in frequent pod recreates on the nodes that got unselected by the merged node selector, which in turn puts unwanted load on the cluster. 5.1.1. Scheduled by default scheduler A daemon set ensures that all eligible nodes run a copy of a pod. Normally, the node that a pod runs on is selected by the Kubernetes scheduler. However, daemon set pods are created and scheduled by the daemon set controller. That introduces the following issues: Inconsistent pod behavior: Normal pods waiting to be scheduled are created and in Pending state, but daemon set pods are not created in Pending state. This is confusing to the user. Pod preemption is handled by default scheduler. When preemption is enabled, the daemon set controller will make scheduling decisions without considering pod priority and preemption. The ScheduleDaemonSetPods feature, enabled by default in OpenShift Container Platform, lets you schedule daemon sets using the default scheduler instead of the daemon set controller, by adding the NodeAffinity term to the daemon set pods, instead of the spec.nodeName term. The default scheduler is then used to bind the pod to the target host. If node affinity of the daemon set pod already exists, it is replaced. The daemon set controller only performs these operations when creating or modifying daemon set pods, and no changes are made to the spec.template of the daemon set. kind: Pod apiVersion: v1 metadata: name: hello-node-6fbccf8d9-9tmzr #... spec: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchFields: - key: metadata.name operator: In values: - target-host-name #... In addition, a node.kubernetes.io/unschedulable:NoSchedule toleration is added automatically to daemon set pods. The default scheduler ignores unschedulable Nodes when scheduling daemon set pods. 5.1.2. Creating daemonsets When creating daemon sets, the nodeSelector field is used to indicate the nodes on which the daemon set should deploy replicas. Prerequisites Before you start using daemon sets, disable the default project-wide node selector in your namespace, by setting the namespace annotation openshift.io/node-selector to an empty string: USD oc patch namespace myproject -p \ '{"metadata": {"annotations": {"openshift.io/node-selector": ""}}}' Tip You can alternatively apply the following YAML to disable the default project-wide node selector for a namespace: apiVersion: v1 kind: Namespace metadata: name: <namespace> annotations: openshift.io/node-selector: '' #... If you are creating a new project, overwrite the default node selector: USD oc adm new-project <name> --node-selector="" Procedure To create a daemon set: Define the daemon set yaml file: apiVersion: apps/v1 kind: DaemonSet metadata: name: hello-daemonset spec: selector: matchLabels: name: hello-daemonset 1 template: metadata: labels: name: hello-daemonset 2 spec: nodeSelector: 3 role: worker containers: - image: openshift/hello-openshift imagePullPolicy: Always name: registry ports: - containerPort: 80 protocol: TCP resources: {} terminationMessagePath: /dev/termination-log serviceAccount: default terminationGracePeriodSeconds: 10 #... 1 The label selector that determines which pods belong to the daemon set. 2 The pod template's label selector. Must match the label selector above. 3 The node selector that determines on which nodes pod replicas should be deployed. A matching label must be present on the node. Create the daemon set object: USD oc create -f daemonset.yaml To verify that the pods were created, and that each node has a pod replica: Find the daemonset pods: USD oc get pods Example output hello-daemonset-cx6md 1/1 Running 0 2m hello-daemonset-e3md9 1/1 Running 0 2m View the pods to verify the pod has been placed onto the node: USD oc describe pod/hello-daemonset-cx6md|grep Node Example output Node: openshift-node01.hostname.com/10.14.20.134 USD oc describe pod/hello-daemonset-e3md9|grep Node Example output Node: openshift-node02.hostname.com/10.14.20.137 Important If you update a daemon set pod template, the existing pod replicas are not affected. If you delete a daemon set and then create a new daemon set with a different template but the same label selector, it recognizes any existing pod replicas as having matching labels and thus does not update them or create new replicas despite a mismatch in the pod template. If you change node labels, the daemon set adds pods to nodes that match the new labels and deletes pods from nodes that do not match the new labels. To update a daemon set, force new pod replicas to be created by deleting the old replicas or nodes. 5.2. Running tasks in pods using jobs A job executes a task in your OpenShift Container Platform cluster. A job tracks the overall progress of a task and updates its status with information about active, succeeded, and failed pods. Deleting a job will clean up any pod replicas it created. Jobs are part of the Kubernetes API, which can be managed with oc commands like other object types. Sample Job specification apiVersion: batch/v1 kind: Job metadata: name: pi spec: parallelism: 1 1 completions: 1 2 activeDeadlineSeconds: 1800 3 backoffLimit: 6 4 template: 5 metadata: name: pi spec: containers: - name: pi image: perl command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"] restartPolicy: OnFailure 6 #... 1 The pod replicas a job should run in parallel. 2 Successful pod completions are needed to mark a job completed. 3 The maximum duration the job can run. 4 The number of retries for a job. 5 The template for the pod the controller creates. 6 The restart policy of the pod. Additional resources Jobs in the Kubernetes documentation 5.2.1. Understanding jobs and cron jobs A job tracks the overall progress of a task and updates its status with information about active, succeeded, and failed pods. Deleting a job cleans up any pods it created. Jobs are part of the Kubernetes API, which can be managed with oc commands like other object types. There are two possible resource types that allow creating run-once objects in OpenShift Container Platform: Job A regular job is a run-once object that creates a task and ensures the job finishes. There are three main types of task suitable to run as a job: Non-parallel jobs: A job that starts only one pod, unless the pod fails. The job is complete as soon as its pod terminates successfully. Parallel jobs with a fixed completion count: a job that starts multiple pods. The job represents the overall task and is complete when there is one successful pod for each value in the range 1 to the completions value. Parallel jobs with a work queue: A job with multiple parallel worker processes in a given pod. OpenShift Container Platform coordinates pods to determine what each should work on or use an external queue service. Each pod is independently capable of determining whether or not all peer pods are complete and that the entire job is done. When any pod from the job terminates with success, no new pods are created. When at least one pod has terminated with success and all pods are terminated, the job is successfully completed. When any pod has exited with success, no other pod should be doing any work for this task or writing any output. Pods should all be in the process of exiting. For more information about how to make use of the different types of job, see Job Patterns in the Kubernetes documentation. Cron job A job can be scheduled to run multiple times, using a cron job. A cron job builds on a regular job by allowing you to specify how the job should be run. Cron jobs are part of the Kubernetes API, which can be managed with oc commands like other object types. Cron jobs are useful for creating periodic and recurring tasks, like running backups or sending emails. Cron jobs can also schedule individual tasks for a specific time, such as if you want to schedule a job for a low activity period. A cron job creates a Job object based on the timezone configured on the control plane node that runs the cronjob controller. Warning A cron job creates a Job object approximately once per execution time of its schedule, but there are circumstances in which it fails to create a job or two jobs might be created. Therefore, jobs must be idempotent and you must configure history limits. 5.2.1.1. Understanding how to create jobs Both resource types require a job configuration that consists of the following key parts: A pod template, which describes the pod that OpenShift Container Platform creates. The parallelism parameter, which specifies how many pods running in parallel at any point in time should execute a job. For non-parallel jobs, leave unset. When unset, defaults to 1 . The completions parameter, specifying how many successful pod completions are needed to finish a job. For non-parallel jobs, leave unset. When unset, defaults to 1 . For parallel jobs with a fixed completion count, specify a value. For parallel jobs with a work queue, leave unset. When unset defaults to the parallelism value. 5.2.1.2. Understanding how to set a maximum duration for jobs When defining a job, you can define its maximum duration by setting the activeDeadlineSeconds field. It is specified in seconds and is not set by default. When not set, there is no maximum duration enforced. The maximum duration is counted from the time when a first pod gets scheduled in the system, and defines how long a job can be active. It tracks overall time of an execution. After reaching the specified timeout, the job is terminated by OpenShift Container Platform. 5.2.1.3. Understanding how to set a job back off policy for pod failure A job can be considered failed, after a set amount of retries due to a logical error in configuration or other similar reasons. Failed pods associated with the job are recreated by the controller with an exponential back off delay ( 10s , 20s , 40s ...) capped at six minutes. The limit is reset if no new failed pods appear between controller checks. Use the spec.backoffLimit parameter to set the number of retries for a job. 5.2.1.4. Understanding how to configure a cron job to remove artifacts Cron jobs can leave behind artifact resources such as jobs or pods. As a user it is important to configure history limits so that old jobs and their pods are properly cleaned. There are two fields within cron job's spec responsible for that: .spec.successfulJobsHistoryLimit . The number of successful finished jobs to retain (defaults to 3). .spec.failedJobsHistoryLimit . The number of failed finished jobs to retain (defaults to 1). Tip Delete cron jobs that you no longer need: USD oc delete cronjob/<cron_job_name> Doing this prevents them from generating unnecessary artifacts. You can suspend further executions by setting the spec.suspend to true. All subsequent executions are suspended until you reset to false . 5.2.1.5. Known limitations The job specification restart policy only applies to the pods , and not the job controller . However, the job controller is hard-coded to keep retrying jobs to completion. As such, restartPolicy: Never or --restart=Never results in the same behavior as restartPolicy: OnFailure or --restart=OnFailure . That is, when a job fails it is restarted automatically until it succeeds (or is manually discarded). The policy only sets which subsystem performs the restart. With the Never policy, the job controller performs the restart. With each attempt, the job controller increments the number of failures in the job status and create new pods. This means that with each failed attempt, the number of pods increases. With the OnFailure policy, kubelet performs the restart. Each attempt does not increment the number of failures in the job status. In addition, kubelet will retry failed jobs starting pods on the same nodes. 5.2.2. Creating jobs You create a job in OpenShift Container Platform by creating a job object. Procedure To create a job: Create a YAML file similar to the following: apiVersion: batch/v1 kind: Job metadata: name: pi spec: parallelism: 1 1 completions: 1 2 activeDeadlineSeconds: 1800 3 backoffLimit: 6 4 template: 5 metadata: name: pi spec: containers: - name: pi image: perl command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"] restartPolicy: OnFailure 6 #... 1 Optional: Specify how many pod replicas a job should run in parallel; defaults to 1 . For non-parallel jobs, leave unset. When unset, defaults to 1 . 2 Optional: Specify how many successful pod completions are needed to mark a job completed. For non-parallel jobs, leave unset. When unset, defaults to 1 . For parallel jobs with a fixed completion count, specify the number of completions. For parallel jobs with a work queue, leave unset. When unset defaults to the parallelism value. 3 Optional: Specify the maximum duration the job can run. 4 Optional: Specify the number of retries for a job. This field defaults to six. 5 Specify the template for the pod the controller creates. 6 Specify the restart policy of the pod: Never . Do not restart the job. OnFailure . Restart the job only if it fails. Always . Always restart the job. For details on how OpenShift Container Platform uses restart policy with failed containers, see the Example States in the Kubernetes documentation. Create the job: USD oc create -f <file-name>.yaml Note You can also create and launch a job from a single command using oc create job . The following command creates and launches a job similar to the one specified in the example: USD oc create job pi --image=perl -- perl -Mbignum=bpi -wle 'print bpi(2000)' 5.2.3. Creating cron jobs You create a cron job in OpenShift Container Platform by creating a job object. Procedure To create a cron job: Create a YAML file similar to the following: apiVersion: batch/v1 kind: CronJob metadata: name: pi spec: schedule: "*/1 * * * *" 1 timeZone: Etc/UTC 2 concurrencyPolicy: "Replace" 3 startingDeadlineSeconds: 200 4 suspend: true 5 successfulJobsHistoryLimit: 3 6 failedJobsHistoryLimit: 1 7 jobTemplate: 8 spec: template: metadata: labels: 9 parent: "cronjobpi" spec: containers: - name: pi image: perl command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"] restartPolicy: OnFailure 10 #... 1 Schedule for the job specified in cron format . In this example, the job will run every minute. 2 An optional time zone for the schedule. See List of tz database time zones for valid options. If not specified, the Kubernetes controller manager interprets the schedule relative to its local time zone. This setting is offered as a Technology Preview . 3 An optional concurrency policy, specifying how to treat concurrent jobs within a cron job. Only one of the following concurrent policies may be specified. If not specified, this defaults to allowing concurrent executions. Allow allows cron jobs to run concurrently. Forbid forbids concurrent runs, skipping the run if the has not finished yet. Replace cancels the currently running job and replaces it with a new one. 4 An optional deadline (in seconds) for starting the job if it misses its scheduled time for any reason. Missed jobs executions will be counted as failed ones. If not specified, there is no deadline. 5 An optional flag allowing the suspension of a cron job. If set to true , all subsequent executions will be suspended. 6 The number of successful finished jobs to retain (defaults to 3). 7 The number of failed finished jobs to retain (defaults to 1). 8 Job template. This is similar to the job example. 9 Sets a label for jobs spawned by this cron job. 10 The restart policy of the pod. This does not apply to the job controller. Note The .spec.successfulJobsHistoryLimit and .spec.failedJobsHistoryLimit fields are optional. These fields specify how many completed and failed jobs should be kept. By default, they are set to 3 and 1 respectively. Setting a limit to 0 corresponds to keeping none of the corresponding kind of jobs after they finish. Create the cron job: USD oc create -f <file-name>.yaml Note You can also create and launch a cron job from a single command using oc create cronjob . The following command creates and launches a cron job similar to the one specified in the example: USD oc create cronjob pi --image=perl --schedule='*/1 * * * *' -- perl -Mbignum=bpi -wle 'print bpi(2000)' With oc create cronjob , the --schedule option accepts schedules in cron format .
[ "kind: Pod apiVersion: v1 metadata: name: hello-node-6fbccf8d9-9tmzr # spec: nodeAffinity: requiredDuringSchedulingIgnoredDuringExecution: nodeSelectorTerms: - matchFields: - key: metadata.name operator: In values: - target-host-name #", "oc patch namespace myproject -p '{\"metadata\": {\"annotations\": {\"openshift.io/node-selector\": \"\"}}}'", "apiVersion: v1 kind: Namespace metadata: name: <namespace> annotations: openshift.io/node-selector: '' #", "oc adm new-project <name> --node-selector=\"\"", "apiVersion: apps/v1 kind: DaemonSet metadata: name: hello-daemonset spec: selector: matchLabels: name: hello-daemonset 1 template: metadata: labels: name: hello-daemonset 2 spec: nodeSelector: 3 role: worker containers: - image: openshift/hello-openshift imagePullPolicy: Always name: registry ports: - containerPort: 80 protocol: TCP resources: {} terminationMessagePath: /dev/termination-log serviceAccount: default terminationGracePeriodSeconds: 10 #", "oc create -f daemonset.yaml", "oc get pods", "hello-daemonset-cx6md 1/1 Running 0 2m hello-daemonset-e3md9 1/1 Running 0 2m", "oc describe pod/hello-daemonset-cx6md|grep Node", "Node: openshift-node01.hostname.com/10.14.20.134", "oc describe pod/hello-daemonset-e3md9|grep Node", "Node: openshift-node02.hostname.com/10.14.20.137", "apiVersion: batch/v1 kind: Job metadata: name: pi spec: parallelism: 1 1 completions: 1 2 activeDeadlineSeconds: 1800 3 backoffLimit: 6 4 template: 5 metadata: name: pi spec: containers: - name: pi image: perl command: [\"perl\", \"-Mbignum=bpi\", \"-wle\", \"print bpi(2000)\"] restartPolicy: OnFailure 6 #", "oc delete cronjob/<cron_job_name>", "apiVersion: batch/v1 kind: Job metadata: name: pi spec: parallelism: 1 1 completions: 1 2 activeDeadlineSeconds: 1800 3 backoffLimit: 6 4 template: 5 metadata: name: pi spec: containers: - name: pi image: perl command: [\"perl\", \"-Mbignum=bpi\", \"-wle\", \"print bpi(2000)\"] restartPolicy: OnFailure 6 #", "oc create -f <file-name>.yaml", "oc create job pi --image=perl -- perl -Mbignum=bpi -wle 'print bpi(2000)'", "apiVersion: batch/v1 kind: CronJob metadata: name: pi spec: schedule: \"*/1 * * * *\" 1 timeZone: Etc/UTC 2 concurrencyPolicy: \"Replace\" 3 startingDeadlineSeconds: 200 4 suspend: true 5 successfulJobsHistoryLimit: 3 6 failedJobsHistoryLimit: 1 7 jobTemplate: 8 spec: template: metadata: labels: 9 parent: \"cronjobpi\" spec: containers: - name: pi image: perl command: [\"perl\", \"-Mbignum=bpi\", \"-wle\", \"print bpi(2000)\"] restartPolicy: OnFailure 10 #", "oc create -f <file-name>.yaml", "oc create cronjob pi --image=perl --schedule='*/1 * * * *' -- perl -Mbignum=bpi -wle 'print bpi(2000)'" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/nodes/using-jobs-and-daemonsets
Chapter 3. Storage classes and storage pools
Chapter 3. Storage classes and storage pools The OpenShift Container Storage operator installs a default storage class depending on the platform in use. This default storage class is owned and controlled by the operator and it cannot be deleted or modified. However, you can create a custom storage class if you want the storage class to have a different behavior. You can create multiple storage pools which map to storage classes that provide the following features: Enable applications with their own high availability to use persistent volumes with two replicas, potentially improving application performance. Save space for persistent volume claims using storage classes with compression enabled. Note Multiple storage classes and multiple pools are not supported for external mode OpenShift Container Storage clusters. Note With a minimal cluster of a single device set, only two new storage classes can be created. Every storage cluster expansion allows two new additional storage classes. 3.1. Creating storage classes and pools You can create a storage class using an existing pool or you can create a new pool for the storage class while creating it. Prerequisites Ensure that the OpenShift Container Storage cluster is in Ready state. Procedure Log in to OpenShift Web Console. Click Storage Storage Classes . Click Create Storage Class . Enter the storage class Name and Description . Select either Delete or Retain for the Reclaim Policy. By default, Delete is selected. Select RBD Provisioner which is the plugin used for provisioning the persistent volumes. You can either create a new pool or use an existing one. Create a new pool Enter a name for the pool. Choose 2-way-Replication or 3-way-Replication as the Data Protection Policy. Select Enable compression if you need to compress the data. Enabling compression can impact application performance and might prove ineffective when data to be written is already compressed or encrypted. Data written before enabling compression will not be compressed. Click Create to create the storage pool. Click Finish after the pool is created. Click Create to create the storage class. Use an existing pool Choose a pool from the list. Click Create to create the storage class with the selected pool.
null
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.0/html/deploying_and_managing_openshift_container_storage_using_red_hat_openstack_platform/storage-classes-and-storage-pools_osp
6.8. Configuring a Failover Domain
6.8. Configuring a Failover Domain A failover domain is a named subset of cluster nodes that are eligible to run a cluster service in the event of a node failure. A failover domain can have the following characteristics: Unrestricted - Allows you to specify that a subset of members are preferred, but that a cluster service assigned to this domain can run on any available member. Restricted - Allows you to restrict the members that can run a particular cluster service. If none of the members in a restricted failover domain are available, the cluster service cannot be started (either manually or by the cluster software). Unordered - When a cluster service is assigned to an unordered failover domain, the member on which the cluster service runs is chosen from the available failover domain members with no priority ordering. Ordered - Allows you to specify a preference order among the members of a failover domain. The member at the top of the list is the most preferred, followed by the second member in the list, and so on. Failback - Allows you to specify whether a service in the failover domain should fail back to the node that it was originally running on before that node failed. Configuring this characteristic is useful in circumstances where a node repeatedly fails and is part of an ordered failover domain. In that circumstance, if a node is the preferred node in a failover domain, it is possible for a service to fail over and fail back repeatedly between the preferred node and another node, causing severe impact on performance. Note The failback characteristic is applicable only if ordered failover is configured. Note Changing a failover domain configuration has no effect on currently running services. Note Failover domains are not required for operation. By default, failover domains are unrestricted and unordered. In a cluster with several members, using a restricted failover domain can minimize the work to set up the cluster to run a cluster service (such as httpd ) which requires you to set up the configuration identically on all members that run the cluster service. Instead of setting up the entire cluster to run the cluster service, you can set up only the members in the restricted failover domain that you associate with the cluster service. Note To configure a preferred member, you can create an unrestricted failover domain comprising only one cluster member. Doing that causes a cluster service to run on that cluster member primarily (the preferred member), but allows the cluster service to fail over to any of the other members. To configure a failover domain, perform the following procedure: To add a failover domain, execute the following command: Note The name should be descriptive enough to distinguish its purpose relative to other names used in your cluster. For example, the following command configures a failover domain named example_pri on node-01.example.com that is unrestricted, ordered, and allows failback: To add a node to a failover domain, execute the following command: For example, to configure the failover domain example_pri in the configuration file on node-01.example.com so that it contains node-01.example.com with a priority of 1, node-02.example.com with a priority of 2, and node-03.example.com with a priority of 3, execute the following commands: Note The priority value is applicable only if ordered failover is configured. You can list all of the failover domains and failover domain nodes configured in a cluster with the following command: To remove a failover domain, execute the following command: To remove a node from a failover domain, execute the following command: Note that when you have finished configuring all of the components of your cluster, you will need to sync the cluster configuration file to all of the nodes, as described in Section 6.15, "Propagating the Configuration File to the Cluster Nodes" .
[ "ccs -h host --addfailoverdomain name [restricted] [ordered] [nofailback]", "ccs -h node-01.example.com --addfailoverdomain example_pri ordered", "ccs -h host --addfailoverdomainnode failoverdomain node priority", "ccs -h node-01.example.com --addfailoverdomainnode example_pri node-01.example.com 1 ccs -h node-01.example.com --addfailoverdomainnode example_pri node-02.example.com 2 ccs -h node-01.example.com --addfailoverdomainnode example_pri node-03.example.com 3", "ccs -h host --lsfailoverdomain", "ccs -h host --rmfailoverdomain name", "ccs -h host --rmfailoverdomainnode failoverdomain node" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/cluster_administration/s1-config-failover-domain-ccs-ca
3.5. Storage
3.5. Storage Storage for virtual machines is abstracted from the physical storage allocated to the virtual machine. It is attached to the virtual machine using the paravirtualized or emulated block device drivers. 3.5.1. Storage Pools A storage pool is a file, directory, or storage device managed by libvirt for the purpose of providing storage to virtual machines. Storage pools are divided into storage volumes that store virtual machine images or are attached to virtual machines as additional storage. Multiple guests can share the same storage pool, allowing for better allocation of storage resources. For more information, see the Red Hat Enterprise Linux 7 Virtualization Deployment and Administration Guide . Local storage pools Local storage pools are attached directly to the host server. They include local directories, directly attached disks, physical partitions, and Logical Volume Management (LVM) volume groups on local devices. Local storage pools are useful for development, testing and small deployments that do not require migration or large numbers of virtual machines. Local storage pools may not be suitable for many production environment, because they do not support live migration. Networked (shared) storage pools Networked storage pools include storage devices shared over a network using standard protocols. Networked storage is required when migrating virtual machines between hosts with virt-manager , but is optional when migrating with virsh . Networked storage pools are managed by libvirt . 3.5.2. Storage Volumes Storage pools are divided into storage volumes . Storage volumes are an abstraction of physical partitions, LVM logical volumes, file-based disk images and other storage types handled by libvirt . Storage volumes are presented to virtual machines as local storage devices regardless of the underlying hardware. 3.5.3. Emulated Storage Devices Virtual machines can be presented with a range of storage devices that are emulated by the host. Each type of storage device is appropriate for specific use cases, allowing for maximum flexibility and compatibility with guest operating systems. virtio-scsi virtio-scsi is the recommended paravirtualized device for guests using large numbers of disks or advanced storage features such as TRIM. Guest driver installation may be necessary on guests using operating systems other than Red Hat Enterprise Linux 7. virtio-blk virtio-blk is a paravirtualized storage device suitable for exposing image files to guests. virtio-blk can provide the best disk I/O performance for virtual machines, but has fewer features than virtio-scsi. IDE IDE is recommended for legacy guests that do not support virtio drivers. IDE performance is lower than virtio-scsi or virtio-blk, but it is widely compatible with different systems. CD-ROM ATAPI CD-ROMs and virtio-scsi CD-ROMs are available and make it possible for guests to use ISO files or the host's CD-ROM drive. virtio-scsi CD-ROMs can be used with guests that have the virtio-scsi driver installed. ATAPI CD-ROMs offer wider compatibility but lower performance. USB mass storage devices and floppy disks Emulated USB mass storage devices and floppy disks are available when removable media are required. USB mass storage devices are preferable to floppy disks due to their larger capacity. 3.5.4. Host Storage Disk images can be stored on a range of local and remote storage technologies connected to the host. Image files Image files can only be stored on a host file system. The image files can be stored on a local file system, such as ext4 or xfs, or a network file system, such as NFS. Tools such as libguestfs can manage, back up, and monitor files. Disk image formats on KVM include: raw Raw image files contain the contents of the disk with no additional metadata. Raw files can either be pre-allocated or sparse, if the host file system allows it. Sparse files allocate host disk space on demand, and are therefore a form of thin provisioning. Pre-allocated files are fully provisioned but have higher performance than sparse files. Raw files are desirable when disk I/O performance is critical and transferring the image file over a network is rarely necessary. qcow2 qcow2 image files offer a number of advanced disk image features, including backing files, snapshots, compression, and encryption. They can be used to instantiate virtual machines from template images. qcow2 files are typically more efficient to transfer over a network, because only sectors written by the virtual machine are allocated in the image. Red Hat Enterprise Linux 7 supports the qcow2 version 3 image file format. LVM volumes Logical volumes (LVs) can be used for disk images and managed using the system's LVM tools. LVM offers higher performance than file systems because of its simpler block storage model. LVM thin provisioning offers snapshots and efficient space usage for LVM volumes, and can be used as an alternative to migrating to qcow2. Host devices Host devices such as physical CD-ROMs, raw disks, and logical unit numbers (LUNs) can be presented to the guest. This enables SAN or iSCSI LUNs as well as local CD-ROM media to be used by the guest with good performance. Host devices can be used when storage management is done on a SAN instead of on hosts. Distributed storage systems Gluster volumes can be used as disk images. This enables high-performance clustered storage over the network. Red Hat Enterprise Linux 7 includes native support for disk images on GlusterFS. This enables a KVM host to boot virtual machine images from GlusterFS volumes, and to use images from a GlusterFS volume as data disks for virtual machines. When compared to GlusterFS FUSE, the native support in KVM delivers higher performance. For more information on storage and virtualization, see the Managing Storage for Virtual Machines .
null
https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/virtualization_getting_started_guide/sec-virtualization_getting_started-products-storage
Chapter 5. Customer privacy
Chapter 5. Customer privacy Various Microsoft products have a feature that reports usage statistics, analytics, and various other metrics to Microsoft over the network. Microsoft calls this Telemetry. Red Hat is disabling telemetry because we do not recommend sending customer data to anyone without explicit permission.
null
https://docs.redhat.com/en/documentation/net/8.0/html/release_notes_for_.net_8.0_rpm_packages/customer-privacy_release-notes-for-dotnet-rpms
7.169. pacemaker
7.169. pacemaker 7.169.1. RHBA-2013:0375 - pacemaker bug fix and enhancement update Updated pacemaker packages that fix several bugs and add various enhancements are now available for Red Hat Enterprise Linux 6. Pacemaker is a high-availability cluster resource manager with a powerful policy engine. Note The pacemaker packages have been upgraded to upstream version 1.1.8, which provides a number of bug fixes and enhancements over the version. (BZ#768522) To minimize the difference between the supported cluster stack, Pacemaker should be used in combination with the CMAN manager. versions of Pacemaker allowed to use the Pacemaker plug-in for the Corosync engine. The plug-in is not supported in this environment and will be removed very soon. Please see http://clusterlabs.org/quickstart-redhat.html and Chapter 8 of "Clusters from Scratch" ( http://clusterlabs.org/doc/en-US/Pacemaker/1.1-plugin/html/Clusters_from_Scratch ) for details on using Pacemaker with CMAN. Bug Fixes BZ# 801355 Multiple parts of the system could notice a node failure at different times. Consequently, if more than one component requested a node to be fenced, the fencing components did so multiple times. This bug has been fixed by merging identical requests from different clients if the first one is still in progress, so the node is fenced only once. BZ# 846983 Canceled operations were incorrectly stored in the cluster status. As a consequence, the cluster detected those operations and tried to clarify the status that led to additional logging and other confusing behavior. The underlying code has been modified so that the canceled operations are no longer stored in the cluster status, and Pacemaker now works as expected. BZ#860684 An improper definition in the spec file caused unexpected implicit dependencies between Pacemaker subpackages; a certain library was in the incorrect location. The libstonithd.so.2 library has been relocated and the dependencies between Pacemaker subpackages are now defined correctly. BZ#877364 On the systems running on AMD64 or Intel 64 architectures, the pacemaker-cts subpackage depends on some libraries from the pacemaker.libs subpackage. However, pacemaker-cts did not specify explicit package version requirement, which could cause dependency problems between new and old subpackages. The version specification of pacemaker-libs has been added to pacemaker-cts to prevent these dependency problems. BZ# 880249 Previously, deleting a master or slave resource led to one of the nodes being fenced. This update applies a patch to fix this bug and nodes are no longer fenced in such a case. BZ# 886151 Previously, the crm_report package did not install the perl-TimeData package as a dependency. Consequently, an attempt to run the crm_report utility on a system without this package failed with an error. This update adds this missing dependency and the crm_report utility can now be run as expected. BZ# 886989 Previously, it was possible to introduce non-significant whitespace characters into the Pacemaker configuration file. Consequently, Pacemaker returned confusing error messages when reading the configuration file. With this update, a patch has been applied to filter the undesired characters from the configuration file and Pacemaker no longer returns such error messages. Enhancements BZ#816875 With this update, Pacemaker provides a simpler XML output, which allows the users easier parsing and querying of the status of cluster resources. BZ#816881 With this update, Pacemaker indicates when a cluster resource is reported as running based on cached information about a node that is no longer connected. All users of Pacemaker are advised to upgrade to these updated packages, which fix these bugs and add these enhancements. 7.169.2. RHEA-2013:1493 - pacemaker bug fix and enhancement update Updated pacemaker packages that fix several bugs and add various enhancements are now available for Red Hat Enterprise Linux 6. The Pacemaker Resource Manager is a collection of technologies working together to provide data integrity and the ability to maintain application availability in the event of a failure. Note The pacemaker packages have been upgraded to upstream version 1.1.10, which provides a number of bug fixes and enhancements over the version. This update is required to enable Pacemaker full support exclusively in combination with Red Hat Open Stack deployments. General Pacemaker support for the Red Hat High Availability add-on will be included in future Red Hat Enterprise Linux 6 releases. (BZ# 1016617 ) Users of Pacemaker are advised to upgrade to these updated packages, which fix these bugs and add these enhancements.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.4_technical_notes/pacemaker
Chapter 87. ImageStreamOutput schema reference
Chapter 87. ImageStreamOutput schema reference Used in: Build The type property is a discriminator that distinguishes use of the ImageStreamOutput type from DockerOutput . It must have the value imagestream for the type ImageStreamOutput . Property Description image The name and tag of the ImageStream where the newly built image will be pushed. For example my-custom-connect:latest . Required. string type Must be imagestream . string
null
https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.5/html/amq_streams_api_reference/type-ImageStreamOutput-reference
Chapter 4. Configuring a system for session recording by using RHEL system roles
Chapter 4. Configuring a system for session recording by using RHEL system roles Use the tlog RHEL system role to record and monitor terminal session activities on your managed nodes in an automatic fashion. You can configure the recording to take place per user or user group by means of the SSSD service. The session recording solution in the tlog RHEL system role consists of the following components: The tlog utility System Security Services Daemon (SSSD) Optional: The web console interface 4.1. Configuring session recording for individual users by using the tlog RHEL system role Prepare and apply an Ansible playbook to configure a RHEL system to log session recording data to the systemd journal. With that, you can enable recording the terminal output and input of a specific user during their sessions, when the user logs in on the console, or by SSH. The playbook installs tlog-rec-session , a terminal session I/O logging program, that acts as the login shell for a user. The role creates an SSSD configuration drop file, and this file defines for which users and groups the login shell should be used. Additionally, if the cockpit package is installed on the system, the playbook also installs the cockpit-session-recording package, which is a Cockpit module that allows you to view and play recordings in the web console interface. Prerequisites You have prepared the control node and the managed nodes You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Deploy session recording hosts: managed-node-01.example.com tasks: - name: Enable session recording for specific users ansible.builtin.include_role: name: rhel-system-roles.tlog vars: tlog_scope_sssd: some tlog_users_sssd: - <recorded_user> tlog_scope_sssd: <value> The some value specifies you want to record only certain users and groups, not all or none . tlog_users_sssd:: <list_of_users> A YAML list of users you want to record a session from. Note that the role does not add users if they do not exist. Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification Check the SSSD drop-in file's content: You can see that the file contains the parameters you set in the playbook. Log in as a user whose session will be recorded, perform some actions, and log out. As the root user: Display the list of recorded sessions: You require the value of the rec (recording ID) field in the step. Note that the value of the _COMM field is shortened due to a 15 character limit. Play back a session: Additional resources /usr/share/ansible/roles/rhel-system-roles.tlog/README.md file /usr/share/doc/rhel-system-roles/tlog/ directory 4.2. Excluding certain users and groups from session recording by using the the tlog RHEL system role You can use the tlog_exclude_users_sssd and tlog_exclude_groups_sssd role variables from the tlog RHEL system role to exclude users or groups from having their sessions recorded and logged in the systemd journal. The playbook installs tlog-rec-session , a terminal session I/O logging program, that acts as the login shell for a user. The role creates an SSSD configuration drop file, and this file defines for which users and groups the login shell should be used. Additionally, if the cockpit package is installed on the system, the playbook also installs the cockpit-session-recording package, which is a Cockpit module that allows you to view and play recordings in the web console interface. Prerequisites You have prepared the control node and the managed nodes You are logged in to the control node as a user who can run playbooks on the managed nodes. The account you use to connect to the managed nodes has sudo permissions on them. Procedure Create a playbook file, for example ~/playbook.yml , with the following content: --- - name: Deploy session recording excluding users and groups hosts: managed-node-01.example.com tasks: - name: Exclude users and groups ansible.builtin.include_role: name: rhel-system-roles.tlog vars: tlog_scope_sssd: all tlog_exclude_users_sssd: - jeff - james tlog_exclude_groups_sssd: - admins tlog_scope_sssd: <value> The value all specifies that you want to record all users and groups. tlog_exclude_users_sssd: <user_list> A YAML list of users user names you want to exclude from the session recording. tlog_exclude_groups_sssd: <group_list> A YAML list of groups you want to exclude from the session recording. Validate the playbook syntax: Note that this command only validates the syntax and does not protect against a wrong but valid configuration. Run the playbook: Verification Check the SSSD drop-in file's content: You can see that the file contains the parameters you set in the playbook. Log in as a user whose session will be recorded, perform some actions, and log out. As the root user: Display the list of recorded sessions: You require the value of the rec (recording ID) field in the step. Note that the value of the _COMM field is shortened due to a 15 character limit. Play back a session: Additional resources /usr/share/ansible/roles/rhel-system-roles.tlog/README.md file /usr/share/doc/rhel-system-roles/tlog/ directory
[ "--- - name: Deploy session recording hosts: managed-node-01.example.com tasks: - name: Enable session recording for specific users ansible.builtin.include_role: name: rhel-system-roles.tlog vars: tlog_scope_sssd: some tlog_users_sssd: - <recorded_user>", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml", "cd /etc/sssd/conf.d/sssd-session-recording.conf", "journalctl _COMM=tlog-rec-sessio Nov 12 09:17:30 managed-node-01.example.com -tlog-rec-session[1546]: {\"ver\":\"2.3\",\"host\":\"managed-node-01.example.com\",\"rec\":\"07418f2b0f334c1696c10cbe6f6f31a6-60a-e4a2\",\"user\":\"demo-user\",", "tlog-play -r journal -M TLOG_REC= <recording_id>", "--- - name: Deploy session recording excluding users and groups hosts: managed-node-01.example.com tasks: - name: Exclude users and groups ansible.builtin.include_role: name: rhel-system-roles.tlog vars: tlog_scope_sssd: all tlog_exclude_users_sssd: - jeff - james tlog_exclude_groups_sssd: - admins", "ansible-playbook --syntax-check ~/playbook.yml", "ansible-playbook ~/playbook.yml", "cat /etc/sssd/conf.d/sssd-session-recording.conf", "journalctl _COMM=tlog-rec-sessio Nov 12 09:17:30 managed-node-01.example.com -tlog-rec-session[1546]: {\"ver\":\"2.3\",\"host\":\"managed-node-01.example.com\",\"rec\":\"07418f2b0f334c1696c10cbe6f6f31a6-60a-e4a2\",\"user\":\"demo-user\",", "tlog-play -r journal -M TLOG_REC= <recording_id>" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/8/html/recording_sessions/configuring-a-system-for-session-recording-using-the-tlog-rhel-system-roles_getting-started-with-session-recording
Chapter 32. Storage
Chapter 32. Storage kernel component, BZ#1170328 When the Internet Small Computer System Interface (iSCSI) target is set up using the iSCSI Extensions for RDMA (iSER) interface, an attempt to run a discovery over iSER fails. Consequently, in some cases, the target panics. Users are advised to not use iSER for discovery but use iSER only for the login phase. kernel component, BZ#1185396 When using the server as an iSER-enabled iSCSI target and connection losses occur repeatedly, the target can stop responding. Consequently, the kernel becomes unresponsive. To work around this issue, minimize iSER connection losses or revert to non-iSER iSCSI mode. kernel component, BZ#1061871, BZ#1201247 When a storage array returns a CHECK CONDITION status but the sense data is invalid, the Small Computer Systems Interface (SCSI) mid-layer code retries the I/O operation. If subsequent I/O operations receive the same result, I/O operations are retried indefinitely. For this bug, no workaround is currently available.
null
https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/7.1_release_notes/known-issues-storage
7.2. Monitoring and Diagnosing Performance Problems
7.2. Monitoring and Diagnosing Performance Problems Red Hat Enterprise Linux 7 provides a number of tools that are useful for monitoring system performance and diagnosing performance problems related to system memory. This section outlines the available tools and gives examples of how to use them to monitor and diagnose memory related performance issues. 7.2.1. Monitoring Memory Usage with vmstat Vmstat , provided by the procps-ng package, outputs reports on your system's processes, memory, paging, block input/output, interrupts, and CPU activity. It provides an instantaneous report of the average of these events since the machine was last booted, or since the report. The following command displays a table of various event counters and memory statistics. For further details of how to use vmstat , see Section A.8, "vmstat" or the man page: 7.2.2. Profiling Application Memory Usage with Valgrind Valgrind is a framework that provides instrumentation to user-space binaries. It ships with a number of tools that can be used to profile and analyze program performance. The valgrind tools outlined in this section can help you to detect memory errors such as uninitialized memory use and improper memory allocation or deallocation. To use valgrind or any of its tools, install the valgrind package: 7.2.2.1. Profiling Memory Usage with Memcheck Memcheck is the default valgrind tool. It detects and reports on a number of memory errors that can be difficult to detect and diagnose, such as: Memory access that should not occur Undefined or uninitialized value use Incorrectly freed heap memory Pointer overlap Memory leaks Note Memcheck can only report these errors; it cannot prevent them from occurring. If your program accesses memory in a way that would normally cause a segmentation fault, the segmentation fault still occurs. However, memcheck will log an error message immediately prior to the fault. Because memcheck uses instrumentation, applications executed with memcheck run ten to thirty times slower than usual. To run memcheck on an application, execute the following command: You can also use the following options to focus memcheck output on specific types of problem. --leak-check After the application finishes executing, memcheck searches for memory leaks. The default value is --leak-check=summary , which prints the number of memory leaks found. You can specify --leak-check=yes or --leak-check=full to output details of each individual leak. To disable, specify --leak-check=no . --undef-value-errors The default value is --undef-value-errors=yes , which reports errors when undefined values are used. You can also specify --undef-value-errors=no , which will disable this report and slightly speed up Memcheck. --ignore-ranges Specifies one or more ranges that memcheck should ignore when checking for memory addressability, for example, --ignore-ranges=0xPP-0xQQ,0xRR-0xSS . For a full list of memcheck options, see the documentation included at /usr/share/doc/valgrind-version/valgrind_manual.pdf . 7.2.2.2. Profiling Cache Usage with Cachegrind Cachegrind simulates application interaction with a system's cache hierarchy and branch predictor. It tracks usage of the simulated first level instruction and data caches to detect poor code interaction with this level of cache. It also tracks the last level of cache (second or third level) in order to track memory access. As such, applications executed with cachegrind run twenty to one hundred times slower than usual. Cachegrind gathers statistics for the duration of application execution and outputs a summary to the console. To run cachegrind on an application, execute the following command: You can also use the following options to focus cachegrind output on a specific problem. --I1 Specifies the size, associativity, and line size of the first level instruction cache, like so: --I1= size , associativity , line_size . --D1 Specifies the size, associativity, and line size of the first level data cache, like so: --D1= size , associativity , line_size . --LL Specifies the size, associativity, and line size of the last level cache, like so: --LL= size , associativity , line_size . --cache-sim Enables or disables the collection of cache access and miss counts. This is enabled ( --cache-sim=yes ) by default. Disabling both this and --branch-sim leaves cachegrind with no information to collect. --branch-sim Enables or disables the collection of branch instruction and incorrect prediction counts. This is enabled ( --branch-sim=yes ) by default. Disabling both this and --cache-sim leaves cachegrind with no information to collect. Cachegrind writes detailed profiling information to a per-process cachegrind.out. pid file, where pid is the process identifier. This detailed information can be further processed by the companion cg_annotate tool, like so: Cachegrind also provides the cg_diff tool, which makes it easier to chart program performance before and after a code change. To compare output files, execute the following command, replacing first with the initial profile output file, and second with the subsequent profile output file. The resulting output file can be viewed in greater detail with the cg_annotate tool. For a full list of cachegrind options, see the documentation included at /usr/share/doc/valgrind-version/valgrind_manual.pdf . 7.2.2.3. Profiling Heap and Stack Space with Massif Massif measures the heap space used by a specified application. It measures both useful space and any additional space allocated for bookkeeping and alignment purposes. massif helps you understand how you can reduce your application's memory use to increase execution speed and reduce the likelihood that your application will exhaust system swap space. Applications executed with massif run about twenty times slower than usual. To run massif on an application, execute the following command: You can also use the following options to focus massif output on a specific problem. --heap Specifies whether massif profiles the heap. The default value is --heap=yes . Heap profiling can be disabled by setting this to --heap=no . --heap-admin Specifies the number of bytes per block to use for administration when heap profiling is enabled. The default value is 8 bytes. --stacks Specifies whether massif profiles the stack. The default value is --stack=no , as stack profiling can greatly slow massif . Set this option to --stack=yes to enable stack profiling. Note that massif assumes that the main stack starts with a size of zero in order to better indicate the changes in stack size that relate to the application being profiled. --time-unit Specifies the interval at which massif gathers profiling data. The default value is i (instructions executed). You can also specify ms (milliseconds, or realtime) and B (bytes allocated or deallocated on the heap and stack). Examining bytes allocated is useful for short run applications and for testing purposes, as it is most reproducible across different hardware. Massif outputs profiling data to a massif.out. pid file, where pid is the process identifier of the specified application. The ms_print tool graphs this profiling data to show memory consumption over the execution of the application, as well as detailed information about the sites responsible for allocation at points of peak memory allocation. To graph the data from the massif.out. pid file, execute the following command: For a full list of Massif options, see the documentation included at /usr/share/doc/valgrind-version/valgrind_manual.pdf .
[ "vmstat -s", "man vmstat", "yum install valgrind", "valgrind --tool=memcheck application", "valgrind --tool=cachegrind application", "cg_annotate cachegrind.out.pid", "cg_diff first second", "valgrind --tool=massif application", "ms_print massif.out.pid" ]
https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/performance_tuning_guide/sect-red_hat_enterprise_linux-performance_tuning_guide-memory-monitoring_and_diagnosing_performance_problems
Providing feedback on Red Hat documentation
Providing feedback on Red Hat documentation We appreciate your input on our documentation. Tell us how we can make it better. Providing documentation feedback in Jira Use the Create Issue form to provide feedback on the documentation. The Jira issue will be created in the Red Hat OpenStack Platform Jira project, where you can track the progress of your feedback. Ensure that you are logged in to Jira. If you do not have a Jira account, create an account to submit feedback. Click the following link to open a the Create Issue page: Create Issue Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form. Click Create .
null
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.2/html/overcloud_parameters/proc_providing-feedback-on-red-hat-documentation
Chapter 5. PersistentVolume [v1]
Chapter 5. PersistentVolume [v1] Description PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes Type object 5.1. Specification Property Type Description apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object PersistentVolumeSpec is the specification of a persistent volume. status object PersistentVolumeStatus is the current status of a persistent volume. 5.1.1. .spec Description PersistentVolumeSpec is the specification of a persistent volume. Type object Property Type Description accessModes array (string) accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes awsElasticBlockStore object Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. azureDisk object AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. azureFile object AzureFile represents an Azure File Service mount on the host and bind mount to the pod. capacity object (Quantity) capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity cephfs object Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. cinder object Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. claimRef object ObjectReference contains enough information to let you inspect or modify the referred object. csi object Represents storage that is managed by an external CSI volume driver (Beta feature) fc object Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. flexVolume object FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. flocker object Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. gcePersistentDisk object Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. glusterfs object Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. hostPath object Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. iscsi object ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. local object Local represents directly-attached storage with node affinity (Beta feature) mountOptions array (string) mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options nfs object Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. nodeAffinity object VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. persistentVolumeReclaimPolicy string persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming Possible enum values: - "Delete" means the volume will be deleted from Kubernetes on release from its claim. The volume plugin must support Deletion. - "Recycle" means the volume will be recycled back into the pool of unbound persistent volumes on release from its claim. The volume plugin must support Recycling. - "Retain" means the volume will be left in its current phase (Released) for manual reclamation by the administrator. The default policy is Retain. photonPersistentDisk object Represents a Photon Controller persistent disk resource. portworxVolume object PortworxVolumeSource represents a Portworx volume resource. quobyte object Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. rbd object Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. scaleIO object ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume storageClassName string storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. storageos object Represents a StorageOS persistent volume resource. volumeAttributesClassName string Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is an alpha field and requires enabling VolumeAttributesClass feature. volumeMode string volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. Possible enum values: - "Block" means the volume will not be formatted with a filesystem and will remain a raw block device. - "Filesystem" means the volume will be or is formatted with a filesystem. vsphereVolume object Represents a vSphere volume resource. 5.1.2. .spec.awsElasticBlockStore Description Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. Type object Required volumeID Property Type Description fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore partition integer partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). readOnly boolean readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore volumeID string volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore 5.1.3. .spec.azureDisk Description AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. Type object Required diskName diskURI Property Type Description cachingMode string cachingMode is the Host Caching mode: None, Read Only, Read Write. Possible enum values: - "None" - "ReadOnly" - "ReadWrite" diskName string diskName is the Name of the data disk in the blob storage diskURI string diskURI is the URI of data disk in the blob storage fsType string fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. kind string kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared Possible enum values: - "Dedicated" - "Managed" - "Shared" readOnly boolean readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. 5.1.4. .spec.azureFile Description AzureFile represents an Azure File Service mount on the host and bind mount to the pod. Type object Required secretName shareName Property Type Description readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretName string secretName is the name of secret that contains Azure Storage Account Name and Key secretNamespace string secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod shareName string shareName is the azure Share Name 5.1.5. .spec.cephfs Description Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. Type object Required monitors Property Type Description monitors array (string) monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it path string path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it secretFile string secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace user string user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it 5.1.6. .spec.cephfs.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.7. .spec.cinder Description Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. Type object Required volumeID Property Type Description fsType string fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace volumeID string volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md 5.1.8. .spec.cinder.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.9. .spec.claimRef Description ObjectReference contains enough information to let you inspect or modify the referred object. Type object Property Type Description apiVersion string API version of the referent. fieldPath string If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. kind string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names namespace string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resourceVersion string Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency uid string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids 5.1.10. .spec.csi Description Represents storage that is managed by an external CSI volume driver (Beta feature) Type object Required driver volumeHandle Property Type Description controllerExpandSecretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace controllerPublishSecretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace driver string driver is the name of the driver to use for this volume. Required. fsType string fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". nodeExpandSecretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace nodePublishSecretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace nodeStageSecretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace readOnly boolean readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). volumeAttributes object (string) volumeAttributes of the volume to publish. volumeHandle string volumeHandle is the unique volume name returned by the CSI volume plugin's CreateVolume to refer to the volume on all subsequent calls. Required. 5.1.11. .spec.csi.controllerExpandSecretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.12. .spec.csi.controllerPublishSecretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.13. .spec.csi.nodeExpandSecretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.14. .spec.csi.nodePublishSecretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.15. .spec.csi.nodeStageSecretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.16. .spec.fc Description Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. Type object Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. lun integer lun is Optional: FC target lun number readOnly boolean readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. targetWWNs array (string) targetWWNs is Optional: FC target worldwide names (WWNs) wwids array (string) wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. 5.1.17. .spec.flexVolume Description FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. Type object Required driver Property Type Description driver string driver is the name of the driver to use for this volume. fsType string fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. options object (string) options is Optional: this field holds extra command options if any. readOnly boolean readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace 5.1.18. .spec.flexVolume.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.19. .spec.flocker Description Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. Type object Property Type Description datasetName string datasetName is Name of the dataset stored as metadata name on the dataset for Flocker should be considered as deprecated datasetUUID string datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset 5.1.20. .spec.gcePersistentDisk Description Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. Type object Required pdName Property Type Description fsType string fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk partition integer partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk pdName string pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk 5.1.21. .spec.glusterfs Description Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. Type object Required endpoints path Property Type Description endpoints string endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod endpointsNamespace string endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path string path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod readOnly boolean readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod 5.1.22. .spec.hostPath Description Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. Type object Required path Property Type Description path string path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath type string type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath Possible enum values: - "" For backwards compatible, leave it empty if unset - "BlockDevice" A block device must exist at the given path - "CharDevice" A character device must exist at the given path - "Directory" A directory must exist at the given path - "DirectoryOrCreate" If nothing exists at the given path, an empty directory will be created there as needed with file mode 0755, having the same group and ownership with Kubelet. - "File" A file must exist at the given path - "FileOrCreate" If nothing exists at the given path, an empty file will be created there as needed with file mode 0644, having the same group and ownership with Kubelet. - "Socket" A UNIX socket must exist at the given path 5.1.23. .spec.iscsi Description ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. Type object Required targetPortal iqn lun Property Type Description chapAuthDiscovery boolean chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication chapAuthSession boolean chapAuthSession defines whether support iSCSI Session CHAP authentication fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi initiatorName string initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection. iqn string iqn is Target iSCSI Qualified Name. iscsiInterface string iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). lun integer lun is iSCSI Target Lun number. portals array (string) portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace targetPortal string targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). 5.1.24. .spec.iscsi.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.25. .spec.local Description Local represents directly-attached storage with node affinity (Beta feature) Type object Required path Property Type Description fsType string fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified. path string path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ... ). 5.1.26. .spec.nfs Description Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. Type object Required server path Property Type Description path string path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs readOnly boolean readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs server string server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs 5.1.27. .spec.nodeAffinity Description VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. Type object Property Type Description required object A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. 5.1.28. .spec.nodeAffinity.required Description A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. Type object Required nodeSelectorTerms Property Type Description nodeSelectorTerms array Required. A list of node selector terms. The terms are ORed. nodeSelectorTerms[] object A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. 5.1.29. .spec.nodeAffinity.required.nodeSelectorTerms Description Required. A list of node selector terms. The terms are ORed. Type array 5.1.30. .spec.nodeAffinity.required.nodeSelectorTerms[] Description A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. Type object Property Type Description matchExpressions array A list of node selector requirements by node's labels. matchExpressions[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. matchFields array A list of node selector requirements by node's fields. matchFields[] object A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. 5.1.31. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions Description A list of node selector requirements by node's labels. Type array 5.1.32. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Possible enum values: - "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn" values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 5.1.33. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields Description A list of node selector requirements by node's fields. Type array 5.1.34. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[] Description A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. Type object Required key operator Property Type Description key string The label key that the selector applies to. operator string Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Possible enum values: - "DoesNotExist" - "Exists" - "Gt" - "In" - "Lt" - "NotIn" values array (string) An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. 5.1.35. .spec.photonPersistentDisk Description Represents a Photon Controller persistent disk resource. Type object Required pdID Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. pdID string pdID is the ID that identifies Photon Controller persistent disk 5.1.36. .spec.portworxVolume Description PortworxVolumeSource represents a Portworx volume resource. Type object Required volumeID Property Type Description fsType string fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. volumeID string volumeID uniquely identifies a Portworx volume 5.1.37. .spec.quobyte Description Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. Type object Required registry volume Property Type Description group string group to map volume access to Default is no group readOnly boolean readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. registry string registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes tenant string tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin user string user to map volume access to Defaults to serivceaccount user volume string volume is a string that references an already created Quobyte volume by name. 5.1.38. .spec.rbd Description Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. Type object Required monitors image Property Type Description fsType string fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd image string image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it keyring string keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it monitors array (string) monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it pool string pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it readOnly boolean readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace user string user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it 5.1.39. .spec.rbd.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.40. .spec.scaleIO Description ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume Type object Required gateway system secretRef Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" gateway string gateway is the host address of the ScaleIO API Gateway. protectionDomain string protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace sslEnabled boolean sslEnabled is the flag to enable/disable SSL communication with Gateway, default false storageMode string storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. storagePool string storagePool is the ScaleIO Storage Pool associated with the protection domain. system string system is the name of the storage system as configured in ScaleIO. volumeName string volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. 5.1.41. .spec.scaleIO.secretRef Description SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace Type object Property Type Description name string name is unique within a namespace to reference a secret resource. namespace string namespace defines the space within which the secret name must be unique. 5.1.42. .spec.storageos Description Represents a StorageOS persistent volume resource. Type object Property Type Description fsType string fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. readOnly boolean readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. secretRef object ObjectReference contains enough information to let you inspect or modify the referred object. volumeName string volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. volumeNamespace string volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. 5.1.43. .spec.storageos.secretRef Description ObjectReference contains enough information to let you inspect or modify the referred object. Type object Property Type Description apiVersion string API version of the referent. fieldPath string If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. kind string Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds name string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names namespace string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resourceVersion string Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency uid string UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids 5.1.44. .spec.vsphereVolume Description Represents a vSphere volume resource. Type object Required volumePath Property Type Description fsType string fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. storagePolicyID string storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. storagePolicyName string storagePolicyName is the storage Policy Based Management (SPBM) profile name. volumePath string volumePath is the path that identifies vSphere volume vmdk 5.1.45. .status Description PersistentVolumeStatus is the current status of a persistent volume. Type object Property Type Description lastPhaseTransitionTime Time lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions. This is a beta field and requires the PersistentVolumeLastPhaseTransitionTime feature to be enabled (enabled by default). message string message is a human-readable message indicating details about why the volume is in this state. phase string phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase Possible enum values: - "Available" used for PersistentVolumes that are not yet bound Available volumes are held by the binder and matched to PersistentVolumeClaims - "Bound" used for PersistentVolumes that are bound - "Failed" used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim - "Pending" used for PersistentVolumes that are not available - "Released" used for PersistentVolumes where the bound PersistentVolumeClaim was deleted released volumes must be recycled before becoming available again this phase is used by the persistent volume claim binder to signal to another process to reclaim the resource reason string reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. 5.2. API endpoints The following API endpoints are available: /api/v1/persistentvolumes DELETE : delete collection of PersistentVolume GET : list or watch objects of kind PersistentVolume POST : create a PersistentVolume /api/v1/watch/persistentvolumes GET : watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead. /api/v1/persistentvolumes/{name} DELETE : delete a PersistentVolume GET : read the specified PersistentVolume PATCH : partially update the specified PersistentVolume PUT : replace the specified PersistentVolume /api/v1/watch/persistentvolumes/{name} GET : watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. /api/v1/persistentvolumes/{name}/status GET : read status of the specified PersistentVolume PATCH : partially update status of the specified PersistentVolume PUT : replace status of the specified PersistentVolume 5.2.1. /api/v1/persistentvolumes HTTP method DELETE Description delete collection of PersistentVolume Table 5.1. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 5.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list or watch objects of kind PersistentVolume Table 5.3. HTTP responses HTTP code Reponse body 200 - OK PersistentVolumeList schema 401 - Unauthorized Empty HTTP method POST Description create a PersistentVolume Table 5.4. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 5.5. Body parameters Parameter Type Description body PersistentVolume schema Table 5.6. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 201 - Created PersistentVolume schema 202 - Accepted PersistentVolume schema 401 - Unauthorized Empty 5.2.2. /api/v1/watch/persistentvolumes HTTP method GET Description watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead. Table 5.7. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 5.2.3. /api/v1/persistentvolumes/{name} Table 5.8. Global path parameters Parameter Type Description name string name of the PersistentVolume HTTP method DELETE Description delete a PersistentVolume Table 5.9. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 5.10. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 202 - Accepted PersistentVolume schema 401 - Unauthorized Empty HTTP method GET Description read the specified PersistentVolume Table 5.11. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified PersistentVolume Table 5.12. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 5.13. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 201 - Created PersistentVolume schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified PersistentVolume Table 5.14. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 5.15. Body parameters Parameter Type Description body PersistentVolume schema Table 5.16. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 201 - Created PersistentVolume schema 401 - Unauthorized Empty 5.2.4. /api/v1/watch/persistentvolumes/{name} Table 5.17. Global path parameters Parameter Type Description name string name of the PersistentVolume HTTP method GET Description watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. Table 5.18. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 5.2.5. /api/v1/persistentvolumes/{name}/status Table 5.19. Global path parameters Parameter Type Description name string name of the PersistentVolume HTTP method GET Description read status of the specified PersistentVolume Table 5.20. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified PersistentVolume Table 5.21. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 5.22. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 201 - Created PersistentVolume schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified PersistentVolume Table 5.23. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 5.24. Body parameters Parameter Type Description body PersistentVolume schema Table 5.25. HTTP responses HTTP code Reponse body 200 - OK PersistentVolume schema 201 - Created PersistentVolume schema 401 - Unauthorized Empty
null
https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/storage_apis/persistentvolume-v1
probe::socket.sendmsg
probe::socket.sendmsg Name probe::socket.sendmsg - Message is currently being sent on a socket. Synopsis Values protocol Protocol value flags Socket flags value name Name of this probe state Socket state value size Message size in bytes type Socket type value family Protocol family value Context The message sender Description Fires at the beginning of sending a message on a socket via the sock_sendmsg function
[ "socket.sendmsg" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/systemtap_tapset_reference/api-socket-sendmsg
Appendix B. Troubleshooting
Appendix B. Troubleshooting The troubleshooting information in the following sections might be helpful when diagnosing issues after the installation process. The following sections are for all supported architectures. However, if an issue is for a particular architecture, it is specified at the start of the section. B.1. Resuming an interrupted download attempt You can resume an interrupted download using the curl command. Prerequisite You have navigated to the Product Downloads section of the Red Hat Customer Portal at https://access.redhat.com/downloads , and selected the required variant, version, and architecture. You have right-clicked on the required ISO file, and selected Copy Link Location to copy the URL of the ISO image file to your clipboard. Procedure Download the ISO image from the new link. Add the --continue-at - option to automatically resume the download: Use a checksum utility such as sha256sum to verify the integrity of the image file after the download finishes: Compare the output with reference checksums provided on the Red Hat Enterprise Linux Product Download web page. Example B.1. Resuming an interrupted download attempt The following is an example of a curl command for a partially downloaded ISO image: B.2. Disks are not detected If the installation program cannot find a writable storage device to install to, it returns the following error message in the Installation Destination window: No disks detected. Please shut down the computer, connect at least one disk, and restart to complete installation. Check the following items: Your system has at least one storage device attached. If your system uses a hardware RAID controller; verify that the controller is properly configured and working as expected. See your controller's documentation for instructions. If you are installing into one or more iSCSI devices and there is no local storage present on the system, verify that all required LUNs are presented to the appropriate Host Bus Adapter (HBA). If the error message is still displayed after rebooting the system and starting the installation process, the installation program failed to detect the storage. In many cases the error message is a result of attempting to install on an iSCSI device that is not recognized by the installation program. In this scenario, you must perform a driver update before starting the installation. Check your hardware vendor's website to determine if a driver update is available. For more general information about driver updates, see the Updating drivers during installation . You can also consult the Red Hat Hardware Compatibility List, available at https://access.redhat.com/ecosystem/search/#/category/Server . B.3. Cannot boot with a RAID card If you cannot boot your system after the installation, you might need to reinstall and repartition your system's storage. Some BIOS types do not support booting from RAID cards. After you finish the installation and reboot the system for the first time, a text-based screen displays the boot loader prompt (for example, grub> ) and a flashing cursor might be displayed. If this is the case, you must repartition your system and move your /boot partition and the boot loader outside of the RAID array. The /boot partition and the boot loader must be on the same drive. Once these changes have been made, you should be able to finish your installation and boot the system properly. B.4. Graphical boot sequence is not responding When rebooting your system for the first time after installation, the system might be unresponsive during the graphical boot sequence. If this occurs, a reset is required. In this scenario, the boot loader menu is displayed successfully, but selecting any entry and attempting to boot the system results in a halt. This usually indicates that there is a problem with the graphical boot sequence. To resolve the issue, you must disable the graphical boot by temporarily altering the setting at boot time before changing it permanently. Procedure: Disabling the graphical boot temporarily Start your system and wait until the boot loader menu is displayed. If you set your boot timeout period to 0 , press the Esc key to access it. From the boot loader menu, use your cursor keys to highlight the entry you want to boot. Press the Tab key on BIOS-based systems or the e key on UEFI-based systems to edit the selected entry options. In the list of options, find the kernel line - that is, the line beginning with the keyword linux . On this line, locate and delete rhgb . Press F10 or Ctrl + X to boot your system with the edited options. If the system started successfully, you can log in normally. However, if you do not disable graphical boot permanently, you must perform this procedure every time the system boots. Procedure: Disabling the graphical boot permanently Log in to the root account on your system. Use the grubby tool to find the default GRUB kernel: Use the grubby tool to remove the rhgb boot option from the default kernel in your GRUB configuration. For example: Reboot the system. The graphical boot sequence is no longer used. If you want to enable the graphical boot sequence, follow the same procedure, replacing the --remove-args="rhgb" parameter with the --args="rhgb" parameter. This restores the rhgb boot option to the default kernel in your GRUB configuration. B.5. X server fails after log in An X server is a program in the X Window System that runs on local machines, that is, the computers used directly by users. X server handles all access to the graphics cards, display screens and input devices, typically a keyboard and mouse on those computers. The X Window System, often referred to as X, is a complete, cross-platform and free client-server system for managing GUIs on single computers and on networks of computers. The client-server model is an architecture that divides the work between two separate but linked applications, referred to as clients and servers.* If X server crashes after login, one or more of the file systems might be full. To troubleshoot the issue, execute the following command: The output verifies which partition is full - in most cases, the problem is on the /home partition. The following is a sample output of the df command: In the example, you can see that the /home partition is full, which causes the failure. Remove any unwanted files. After you free up some disk space, start X using the startx command. For additional information about df and an explanation of the options available, such as the -h option used in this example, see the df(1) man page on your system. *Source: http://www.linfo.org/x_server.html B.6. RAM is not recognized In some scenarios, the kernel does not recognize all memory (RAM), which causes the system to use less memory than is installed. If the total amount of memory that your system reports does not match your expectations, it is likely that at least one of your memory modules is faulty. On BIOS-based systems, you can use the Memtest86+ utility to test your system's memory. Some hardware configurations have part of the system's RAM reserved, and as a result, it is unavailable to the system. Some laptop computers with integrated graphics cards reserve a portion of memory for the GPU. For example, a laptop with 4 GiB of RAM and an integrated Intel graphics card shows roughly 3.7 GiB of available memory. Additionally, the kdump crash kernel dumping mechanism, which is enabled by default on most Red Hat Enterprise Linux systems, reserves some memory for the secondary kernel used in case of a primary kernel failure. This reserved memory is not displayed as available. Use this procedure to manually set the amount of memory. Procedure Check the amount of memory that your system currently reports in MiB: Reboot your system and wait until the boot loader menu is displayed. If your boot timeout period is set to 0 , press the Esc key to access the menu. From the boot loader menu, use your cursor keys to highlight the entry you want to boot, and press the Tab key on BIOS-based systems or the e key on UEFI-based systems to edit the selected entry options. In the list of options, find the kernel line: that is, the line beginning with the keyword linux . Append the following option to the end of this line: Replace xx with the amount of RAM you have in MiB. Press F10 or Ctrl + X to boot your system with the edited options. Wait for the system to boot, log in, and open a command line. Check the amount of memory that your system reports in MiB: If the total amount of RAM displayed by the command now matches your expectations, make the change permanent: B.7. System is displaying signal 11 errors A signal 11 error, commonly known as a segmentation fault, means that a program accessed a memory location that it was not assigned. A signal 11 error can occur due to a bug in one of the software programs that are installed, or faulty hardware. If you receive a signal 11 error during the installation process, verify that you are using the most recent installation images and prompt the installation program to verify them to ensure they are not corrupt. For more information, see Verifying Boot media . Faulty installation media (such as an improperly burned or scratched optical disk) are a common cause of signal 11 errors. Verify the integrity of the installation media before every installation. For information about obtaining the most recent installation media, refer to the Product Downloads page. To perform a media check before the installation starts, append the rd.live.check boot option at the boot menu. If you performed a media check without any errors and you still have issues with segmentation faults, it usually indicates that your system encountered a hardware error. In this scenario, the problem is most likely in the system's memory (RAM). This can be a problem even if you previously used a different operating system on the same computer without any errors. Note For AMD and Intel 64-bit and 64-bit ARM architectures: On BIOS-based systems, you can use the Memtest86+ memory testing module included on the installation media to perform a thorough test of your system's memory. For more information, see Detecting memory faults using the Memtest86 application . Other possible causes are beyond this document's scope. Consult your hardware manufacturer's documentation and also see the Red Hat Hardware Compatibility List, available online at https://access.redhat.com/ecosystem/search/#/category/Server . B.8. Unable to IPL from network storage space on IBM Power Systems If you experience difficulties when trying to IPL from Network Storage Space (*NWSSTG), it is most likely due to a missing PReP partition. In this scenario, you must reinstall the system and create this partition during the partitioning phase or in the Kickstart file. B.9. Using XDMCP There are scenarios where you have installed the X Window System and want to log in to your Red Hat Enterprise Linux system using a graphical login manager. Use this procedure to enable the X Display Manager Control Protocol (XDMCP) and remotely log in to a desktop environment from any X-compatible client, such as a network-connected workstation or X11 terminal. Note XDMCP is not supported by the Wayland protocol. Procedure Open the /etc/gdm/custom.conf configuration file in a plain text editor such as vi or nano . In the custom.conf file, locate the section starting with [xdmcp] . In this section, add the following line: If you are using XDMCP, ensure that WaylandEnable=false is present in the /etc/gdm/custom.conf file. Save the file and exit the text editor. Restart the X Window System. To do this, either reboot the system, or restart the GNOME Display Manager using the following command as root: Warning Restarting the gdm service terminates all currently running GNOME sessions of all desktop users who are logged in. This might result in users losing unsaved data. Wait for the login prompt and log in using your user name and password. The X Window System is now configured for XDMCP. You can connect to it from another workstation (client) by starting a remote X session using the X command on the client workstation. For example: Replace address with the host name of the remote X11 server. The command connects to the remote X11 server using XDMCP and displays the remote graphical login screen on display :1 of the X11 server system (usually accessible by pressing Ctrl-Alt-F8 ). You can also access remote desktop sessions using a nested X11 server, which opens the remote desktop as a window in your current X11 session. You can use Xnest to open a remote desktop nested in a local X11 session. For example, run Xnest using the following command, replacing address with the host name of the remote X11 server: Additional resources X Window System documentation B.10. Using rescue mode The installation program's rescue mode is a minimal Linux environment that can be booted from the Red Hat Enterprise Linux DVD or other boot media. It contains command-line utilities for repairing a wide variety of issues. Rescue mode can be accessed from the Troubleshooting menu of the boot menu. In this mode, you can mount file systems as read-only, blacklist or add a driver provided on a driver disc, install or upgrade system packages, or manage partitions. Note The installation program's rescue mode is different from rescue mode (an equivalent to single-user mode) and emergency mode, which are provided as parts of the systemd system and service manager. To boot into rescue mode, you must be able to boot the system using one of the Red Hat Enterprise Linux boot media, such as a minimal boot disc or USB drive, or a full installation DVD. Important Advanced storage, such as iSCSI or zFCP devices, must be configured either using dracut boot options such as rd.zfcp= or root=iscsi: options , or in the CMS configuration file on 64-bit IBM Z. It is not possible to configure these storage devices interactively after booting into rescue mode. For information about dracut boot options, see the dracut.cmdline(7) man page on your system. B.10.1. Booting into rescue mode This procedure describes how to boot into rescue mode. Procedure Boot the system from either minimal boot media, or a full installation DVD or USB drive, and wait for the boot menu to be displayed. From the boot menu, either select Troubleshooting > Rescue a Red Hat Enterprise Linux system option, or append the inst.rescue option to the boot command line. To enter the boot command line, press the Tab key on BIOS-based systems or the e key on UEFI-based systems. Optional: If your system requires a third-party driver provided on a driver disc to boot, append the inst.dd=driver_name to the boot command line: Optional: If a driver that is part of the Red Hat Enterprise Linux distribution prevents the system from booting, append the modprobe.blacklist= option to the boot command line: Press Enter (BIOS-based systems) or Ctrl + X (UEFI-based systems) to boot the modified option. Wait until the following message is displayed: If you select 1 , the installation program attempts to mount your file system under the directory /mnt/sysroot/ . You are notified if it fails to mount a partition. If you select 2 , it attempts to mount your file system under the directory /mnt/sysroot/ , but in read-only mode. If you select 3 , your file system is not mounted. For the system root, the installer supports two mount points /mnt/sysimage and /mnt/sysroot . The /mnt/sysroot path is used to mount / of the target system. Usually, the physical root and the system root are the same, so /mnt/sysroot is attached to the same file system as /mnt/sysimage . The only exceptions are rpm-ostree systems, where the system root changes based on the deployment. Then, /mnt/sysroot is attached to a subdirectory of /mnt/sysimage . Use /mnt/sysroot for chroot. Select 1 to continue. Once your system is in rescue mode, a prompt appears on VC (virtual console) 1 and VC 2. Use the Ctrl+Alt+F1 key combination to access VC 1 and Ctrl+Alt+F2 to access VC 2: Even if your file system is mounted, the default root partition while in rescue mode is a temporary root partition, not the root partition of the file system used during normal user mode ( multi-user.target or graphical.target ). If you selected to mount your file system and it mounted successfully, you can change the root partition of the rescue mode environment to the root partition of your file system by executing the following command: This is useful if you need to run commands, such as rpm , that require your root partition to be mounted as / . To exit the chroot environment, type exit to return to the prompt. If you selected 3 , you can still try to mount a partition or LVM2 logical volume manually inside rescue mode by creating a directory, such as /directory/ , and typing the following command: In the above command, /directory/ is the directory that you created and /dev/mapper/VolGroup00-LogVol02 is the LVM2 logical volume you want to mount. If the partition is a different type than XFS, replace the xfs string with the correct type (such as ext4). If you do not know the names of all physical partitions, use the following command to list them: If you do not know the names of all LVM2 physical volumes, volume groups, or logical volumes, use the pvdisplay , vgdisplay or lvdisplay commands. B.10.2. Using an SOS report in rescue mode The sosreport command-line utility collects configuration and diagnostic information, such as the running kernel version, loaded modules, and system and service configuration files from the system. The utility output is stored in a tar archive in the /var/tmp/ directory. The sosreport utility is useful for analyzing system errors and troubleshooting. Use this procedure to capture an sosreport output in rescue mode. Prerequisites You have booted into rescue mode. You have mounted the installed system / (root) partition in read-write mode. You have contacted Red Hat Support about your case and received a case number. Procedure Change the root directory to the /mnt/sysroot/ directory: Execute sosreport to generate an archive with system configuration and diagnostic information: sosreport prompts you to enter your name and the case number you received from Red Hat Support. Use only letters and numbers because adding any of the following characters or spaces could render the report unusable: # % & { } \ < > > * ? / USD ~ ' " : @ + ` | = Optional: If you want to transfer the generated archive to a new location using the network, it is necessary to have a network interface configured. In this scenario, use the dynamic IP addressing as no other steps required. However, when using static addressing, enter the following command to assign an IP address (for example 10.13.153.64/23) to a network interface, for example dev eth0: Exit the chroot environment: Store the generated archive in a new location, from where it can be easily accessible: For transferring the archive through the network, use the scp utility: Additional resources What is an sosreport and how to create one in Red Hat Enterprise Linux? (Red Hat Knowledgebase) How to generate sosreport from the rescue environment (Red Hat Knowledgebase) How do I make sosreport write to an alternative location? (Red Hat Knowledgebase) Sosreport fails. What data should I provide in its place? (Red Hat Knowledgebase) B.10.3. Reinstalling the GRUB boot loader In some scenarios, the GRUB boot loader is mistakenly deleted, corrupted, or replaced by other operating systems. In that case, reinstall GRUB on the master boot record (MBR) on AMD64 and Intel 64 systems with BIOS. Prerequisites You have booted into rescue mode. You have mounted the installed system / (root) partition in read-write mode. You have mounted the /boot mount point in read-write mode. Procedure Change the root partition: Reinstall the GRUB boot loader, where the install_device block device was installed: Important Running the grub2-install command could lead to the machine being unbootable if all the following conditions apply: The system is an AMD64 or Intel 64 with Extensible Firmware Interface (EFI). Secure Boot is enabled. After you run the grub2-install command, you cannot boot the AMD64 or Intel 64 systems that have Extensible Firmware Interface (EFI) and Secure Boot enabled. This issue occurs because the grub2-install command installs an unsigned GRUB image that boots directly instead of using the shim application. When the system boots, the shim application validates the image signature, which when not found fails to boot the system. Reboot the system. B.10.4. Using dnf to add or remove a driver Missing or malfunctioning drivers cause problems when booting the system. Rescue mode provides an environment in which you can add or remove a driver even when the system fails to boot. Wherever possible, use the dnf package manager to remove malfunctioning drivers or to add updated or missing drivers. Important When you install a driver from a driver disc, the driver disc updates all initramfs images on the system to use this driver. If a problem with a driver prevents a system from booting, you cannot rely on booting the system from another initramfs image. B.10.4.1. Adding a driver using dnf Use this procedure to add a driver. Prerequisites You have booted into rescue mode. You have mounted the installed system in read-write mode. Procedure Make the RPM package that contains the driver available. For example, mount a CD or USB flash drive and copy the RPM package to a location of your choice under /mnt/sysroot/ , for example: /mnt/sysroot/root/drivers/ . Change the root directory to /mnt/sysroot/ : Use the dnf install command to install the driver package. For example, run the following command to install the xorg-x11-drv-wacom driver package from /root/drivers/ : Note The /root/drivers/ directory in this chroot environment is the /mnt/sysroot/root/drivers/ directory in the original rescue environment. Exit the chroot environment: B.10.4.2. Removing a driver using dnf Use this procedure to remove a driver. Prerequisites You have booted into rescue mode. You have mounted the installed system in read-write mode. Procedure Change the root directory to the /mnt/sysroot/ directory: Use the dnf remove command to remove the driver package. For example, to remove the xorg-x11-drv-wacom driver package, run: Exit the chroot environment: If you cannot remove a malfunctioning driver for some reason, you can instead blocklist the driver so that it does not load at boot time. When you have finished adding and removing drivers, reboot the system. B.11. ip= boot option returns an error Using the ip= boot option format ip=[ip address] for example, ip=192.168.1.1 returns the error message Fatal for argument 'ip=[insert ip here]'\n sorry, unknown value [ip address] refusing to continue . In releases of Red Hat Enterprise Linux, the boot option format was: However, in Red Hat Enterprise Linux 9, the boot option format is: To resolve the issue, use the format: ip=ip::gateway:netmask:hostname:interface:none where: ip specifies the client ip address. You can specify IPv6 addresses in square brackets, for example, [2001:DB8::1] . gateway is the default gateway. IPv6 addresses are also accepted. netmask is the netmask to be used. This can be either a full netmask, for example, 255.255.255.0, or a prefix, for example, 64 . hostname is the host name of the client system. This parameter is optional. Additional resources Network boot options B.12. Cannot boot into the graphical installation on iLO or iDRAC devices The graphical installer for a remote ISO installation on iLO or iDRAC devices may not be available due to a slow internet connection. To proceed with the installation in this case, you can choose one of the following methods: Avoid the timeout. To do so: Press the Tab key in case of BIOS usage, or the e key in case of UEFI usage when booting from an installation media. That will allow you to modify the kernel command line arguments. To proceed with the installation, append the rd.live.ram=1 and press Enter in case of BIOS usage, or Ctrl+x in case of UEFI usage. This might take longer to load the installation program. Another option to extend the loading time for the graphical installer is to set the inst.xtimeout kernel argument in seconds. You can install the system in text mode. For more details, see Installing RHEL8 in text mode . In the remote management console, such as iLO or iDRAC, instead of a local media source, use the direct URL to the installation ISO file from the Download center on the Red Hat Customer Portal. You must be logged in to access this section. B.13. Rootfs image is not initramfs If you get the following message on the console during booting the installer, the transfer of the installer initrd.img might have had errors: To resolve this issue, download initrd again or run the sha256sum with initrd.img and compare it with the checksum stored in the .treeinfo file on the installation medium, for example, To view the checksum in .treeinfo : Despite having correct initrd.img , if you get the following kernel messages during booting the installer, often a boot parameter is missing or mis-spelled, and the installer could not load stage2 , typically referred to by the inst.repo= parameter, providing the full installer initial ramdisk for its in-memory root file system: To resolve this issue, check if the installation source specified is correct on the kernel command line ( inst.repo= ) or in the kickstart file the network configuration is specified on the kernel command line (if the installation source is specified as network) the network installation source is accessible from another system
[ "curl --output directory-path/filename.iso 'new_copied_link_location' --continue-at -", "sha256sum rhel-x.x-x86_64-dvd.iso `85a...46c rhel-x.x-x86_64-dvd.iso`", "curl --output _rhel-x.x-x86_64-dvd.iso 'https://access.cdn.redhat.com//content/origin/files/sha256/85/85a...46c/rhel-x.x-x86_64-dvd.iso?_auth =141...963' --continue-at -", "grubby --default-kernel /boot/vmlinuz-4.18.0-94.el8.x86_64", "grubby --remove-args=\"rhgb\" --update-kernel /boot/vmlinuz-4.18.0-94.el8.x86_64", "df -h", "Filesystem Size Used Avail Use% Mounted on devtmpfs 396M 0 396M 0% /dev tmpfs 411M 0 411M 0% /dev/shm tmpfs 411M 6.7M 405M 2% /run tmpfs 411M 0 411M 0% /sys/fs/cgroup /dev/mapper/rhel-root 17G 4.1G 13G 25% / /dev/sda1 1014M 173M 842M 17% /boot tmpfs 83M 20K 83M 1% /run/user/42 tmpfs 83M 84K 83M 1% /run/user/1000 /dev/dm-4 90G 90G 0 100% /home", "free -m", "mem= xx M", "free -m", "grubby --update-kernel=ALL --args=\"mem= xx M\"", "Enable=true", "systemctl restart gdm.service", "X :1 -query address", "Xnest :1 -query address", "inst.rescue inst.dd=driver_name", "inst.rescue modprobe.blacklist=driver_name", "The rescue environment will now attempt to find your Linux installation and mount it under the directory: /mnt/sysroot/. You can then make any changes required to your system. Choose 1 to proceed with this step. You can choose to mount your file systems read-only instead of read-write by choosing 2 . If for some reason this process does not work choose 3 to skip directly to a shell. 1) Continue 2) Read-only mount 3) Skip to shell 4) Quit (Reboot)", "sh-4.2#", "sh-4.2# chroot /mnt/sysroot", "sh-4.2# mount -t xfs /dev/mapper/VolGroup00-LogVol02 /directory", "sh-4.2# fdisk -l", "sh-4.2# chroot /mnt/sysroot/", "sh-4.2# sosreport", "bash-4.2# ip addr add 10.13.153.64/23 dev eth0", "sh-4.2# exit", "sh-4.2# cp /mnt/sysroot/var/tmp/sosreport new_location", "sh-4.2# scp /mnt/sysroot/var/tmp/sosreport username@hostname:sosreport", "sh-4.2# chroot /mnt/sysroot/", "sh-4.2# /sbin/grub2-install install_device", "sh-4.2# chroot /mnt/sysroot/", "sh-4.2# dnf install /root/drivers/xorg-x11-drv-wacom-0.23.0-6.el7.x86_64.rpm", "sh-4.2# exit", "sh-4.2# chroot /mnt/sysroot/", "sh-4.2# dnf remove xorg-x11-drv-wacom", "sh-4.2# exit", "ip=192.168.1.15 netmask=255.255.255.0 gateway=192.168.1.254 nameserver=192.168.1.250 hostname=myhost1", "ip=192.168.1.15::192.168.1.254:255.255.255.0:myhost1::none: nameserver=192.168.1.250", "inst.xtimeout= N", "[ ...] rootfs image is not initramfs", "sha256sum dvd/images/pxeboot/initrd.img fdb1a70321c06e25a1ed6bf3d8779371b768d5972078eb72b2c78c925067b5d8 dvd/images/pxeboot/initrd.img", "grep sha256 dvd/.treeinfo images/efiboot.img = sha256: d357d5063b96226d643c41c9025529554a422acb43a4394e4ebcaa779cc7a917 images/install.img = sha256: 8c0323572f7fc04e34dd81c97d008a2ddfc2cfc525aef8c31459e21bf3397514 images/pxeboot/initrd.img = sha256: fdb1a70321c06e25a1ed6bf3d8779371b768d5972078eb72b2c78c925067b5d8 images/pxeboot/vmlinuz = sha256: b9510ea4212220e85351cbb7f2ebc2b1b0804a6d40ccb93307c165e16d1095db", "[ ...] No filesystem could mount root, tried: [ ...] Kernel panic - not syncing: VFS: Unable to mount root fs on unknown-block(1,0) [ ...] CPU: 0 PID: 1 Comm: swapper/0 Not tainted 5.14.0-55.el9.s390x #1 [ ...] [ ...] Call Trace: [ ...] ([<...>] show_trace+0x.../0x...) [ ...] [<...>] show_stack+0x.../0x [ ...] [<...>] panic+0x.../0x [ ...] [<...>] mount_block_root+0x.../0x [ ...] [<...>] prepare_namespace+0x.../0x [ ...] [<...>] kernel_init_freeable+0x.../0x [ ...] [<...>] kernel_init+0x.../0x [ ...] [<...>] kernel_thread_starter+0x.../0x [ ...] [<...>] kernel_thread_starter+0x.../0x..." ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/interactively_installing_rhel_over_the_network/troubleshooting-after-installation_rhel-installer
Operators
Operators OpenShift Container Platform 4.10 Working with Operators in OpenShift Container Platform Red Hat OpenShift Documentation Team
null
https://docs.redhat.com/en/documentation/openshift_container_platform/4.10/html/operators/index
Using Streams for Apache Kafka on RHEL in KRaft mode
Using Streams for Apache Kafka on RHEL in KRaft mode Red Hat Streams for Apache Kafka 2.7 Configure and manage a deployment of Streams for Apache Kafka 2.7 on Red Hat Enterprise Linux
null
https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.7/html/using_streams_for_apache_kafka_on_rhel_in_kraft_mode/index
Chapter 1. Overview of HawtIO
Chapter 1. Overview of HawtIO Important Technology Preview features are not supported with Red Hat production service-level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend implementing any Technology Preview features in production environments. This Technology Preview feature provides early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. For more information about support scope, see Technology Preview Features Support Scope . HawtIO is a diagnostic Console for the Red Hat build of Apache Camel and Red Hat build of AMQ. It is a pluggable Web diagnostic console built with modern Web technologies such as React and PatternFly . HawtIO provides a central interface to examine and manage the details of one or more deployed HawtIO-enabled containers. HawtIO is available when you install HawtIO standalone or use HawtIO on OpenShift. The integrations that you can view and manage in HawtIO depend on the plugins that are running. You can monitor HawtIO and system resources, perform updates, and start or stop services. The pluggable architecture is based on Webpack Module Federation and is highly extensible; you can dynamically extend HawtIO with your plugins or automatically discover plugins inside the JVM. HawtIO has built-in plugins already to make it highly useful out of the box for your JVM application. The plugins include Apache Camel, Connect, JMX, Logs, Runtime, Quartz, and Spring Boot. HawtIO is primarily designed to be used with Camel Quarkus and Camel Spring Boot. It's also a tool for managing microservice applications. HawtIO is cloud-native; it's ready to go over the cloud! You can deploy it to Kubernetes and OpenShift with the HawtIO Operator . Benefits of HawtIO can be listed as follows: Runtime management of JVM via JMX, especially that of Camel applications and AMQ broker, with specialized views Visualization and debugging/tracing of Camel routes Simple managing and monitoring of application metrics
null
https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel/4.0/html/hawtio_diagnostic_console_guide/overview-of-hawtio
24.5. Performance Tuning
24.5. Performance Tuning Click on the Performance Tuning tab to configure the maximum number of child server processes you want and to configure the Apache HTTP Server options for client connections. The default settings for these options are appropriate for most situations. Altering these settings may affect the overall performance of your Web server. Figure 24.11. Performance Tuning Set Max Number of Connections to the maximum number of simultaneous client requests that the server can handle. For each connection, a child httpd process is created. After this maximum number of processes is reached, no one else can connect to the Web server until a child server process is freed. You can not set this value to higher than 256 without recompiling. This option corresponds to the MaxClients directive. Connection Timeout defines, in seconds, the amount of time that your server waits for receipts and transmissions during communications. Specifically, Connection Timeout defines how long your server waits to receive a GET request, how long it waits to receive TCP packets on a POST or PUT request, and how long it waits between ACKs responding to TCP packets. By default, Connection Timeout is set to 300 seconds, which is appropriate for most situations. This option corresponds to the TimeOut directive. Set the Max requests per connection to the maximum number of requests allowed per persistent connection. The default value is 100, which should be appropriate for most situations. This option corresponds to the MaxRequestsPerChild directive. If you check the Allow unlimited requests per connection option, the MaxKeepAliveRequests directive is set to 0 and unlimited requests are allowed. If you uncheck the Allow Persistent Connections option, the KeepAlive directive is set to false. If you check it, the KeepAlive directive is set to true, and the KeepAliveTimeout directive is set to the number that is selected as the Timeout for Connection value. This directive sets the number of seconds your server waits for a subsequent request, after a request has been served, before it closes the connection. Once a request has been received, the Connection Timeout value applies instead. Setting the Persistent Connections to a high value may cause the server to slow down, depending on how many users are trying to connect to it. The higher the number, the more server processes are waiting for another connection from the last client that connected to it.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/system_administration_guide/httpd_configuration-performance_tuning
Chapter 1. Introduction to provisioning
Chapter 1. Introduction to provisioning Provisioning is a process that starts with a bare physical or virtual machine and ends with a fully configured, ready-to-use operating system. Using Red Hat Satellite, you can define and automate fine-grained provisioning for a large number of hosts. 1.1. Provisioning methods in Red Hat Satellite With Red Hat Satellite, you can provision hosts by using the following methods. Bare-metal hosts Satellite provisions bare-metal hosts primarily by using PXE boot and MAC address identification. When provisioning bare-metal hosts with Satellite, you can do the following: Create host entries and specify the MAC address of the physical host to provision. Boot blank hosts to use the Satellite Discovery service, which creates a pool of hosts that are ready for provisioning. Cloud providers Satellite connects to private and public cloud providers to provision instances of hosts from images stored in the cloud environment. When provisioning from cloud with Satellite, you can do the following: Select which hardware profile to use. Provision cloud instances from specific providers by using their APIs. Virtualization infrastructure Satellite connects to virtualization infrastructure services, such as Red Hat Virtualization and VMware. When provisioning virtual machines with Satellite, you can do the following: Provision virtual machines from virtual image templates. Use the same PXE-based boot methods that you use to provision bare-metal hosts. 1.2. Supported cloud providers You can connect the following cloud providers as compute resources to Satellite: Red Hat OpenStack Platform Amazon EC2 Google Compute Engine Microsoft Azure 1.3. Supported virtualization infrastructures You can connect the following virtualization infrastructures as compute resources to Satellite: KVM (libvirt) Red Hat Virtualization (deprecated) VMware OpenShift Virtualization 1.4. Network boot provisioning workflow The provisioning process follows a basic PXE workflow: You create a host and select a domain and subnet. Satellite requests an available IP address from the DHCP Capsule Server that is associated with the subnet or from the PostgreSQL database in Satellite. Satellite loads this IP address into the IP address field in the Create Host window. When you complete all the options for the new host, submit the new host request. Depending on the configuration specifications of the host and its domain and subnet, Satellite creates the following settings: A DHCP record on Capsule Server that is associated with the subnet. A forward DNS record on Capsule Server that is associated with the domain. A reverse DNS record on the DNS Capsule Server that is associated with the subnet. PXELinux, Grub, Grub2, and iPXE configuration files for the host in the TFTP Capsule Server that is associated with the subnet. A Puppet certificate on the associated Puppet server. A realm on the associated identity server. The host is configured to boot from the network as the first device and HDD as the second device. The new host requests a DHCP reservation from the DHCP server. The DHCP server responds to the reservation request and returns TFTP -server and filename options. The host requests the boot loader and menu from the TFTP server according to the PXELoader setting. A boot loader is returned over TFTP. The boot loader fetches configuration for the host through its provisioning interface MAC address. The boot loader fetches the operating system installer kernel, init RAM disk, and boot parameters. The installer requests the provisioning template from Satellite. Satellite renders the provision template and returns the result to the host. The installer performs installation of the operating system. The installer registers the host to Satellite using Subscription Manager. The installer notifies Satellite of a successful build in the postinstall script. The PXE configuration files revert to a local boot template. The host reboots. The new host requests a DHCP reservation from the DHCP server. The DHCP server responds to the reservation request and returns TFTP -server and filename options. The host requests the bootloader and menu from the TFTP server according to the PXELoader setting. A boot loader is returned over TFTP. The boot loader fetches the configuration for the host through its provision interface MAC address. The boot loader initiates boot from the local drive. If you configured the host to use any Puppet classes, the host configures itself using the modules. The fully provisioned host performs the following workflow: The host is configured to boot from the network as the first device and HDD as the second device. The new host requests a DHCP reservation from the DHCP server. The DHCP server responds to the reservation request and returns TFTP -server and filename options. The host requests the boot loader and menu from the TFTP server according to the PXELoader setting. A boot loader is returned over TFTP. The boot loader fetches the configuration settings for the host through its provisioning interface MAC address. For BIOS hosts: The boot loader returns non-bootable device so BIOS skips to the device (boot from HDD). For EFI hosts: The boot loader finds Grub2 on a ESP partition and chainboots it. If the host is unknown to Satellite, a default bootloader configuration is provided. When Discovery service is enabled, it boots into discovery, otherwise it boots from HDD. This workflow differs depending on custom options. For example: Discovery If you use the discovery service, Satellite automatically detects the MAC address of the new host and restarts the host after you submit a request. Note that TCP port 8443 must be reachable by the Capsule to which the host is attached for Satellite to restart the host. PXE-less Provisioning After you submit a new host request, you must boot the specific host with the boot disk that you download from Satellite and transfer using a USB port of the host. Compute Resources Satellite creates the virtual machine and retrieves the MAC address and stores the MAC address in Satellite. If you use image-based provisioning, the host does not follow the standard PXE boot and operating system installation. The compute resource creates a copy of the image for the host to use. Depending on image settings in Satellite, seed data can be passed in for initial configuration, for example using cloud-init . Satellite can connect using SSH to the host and execute a template to finish the customization. Note By default, deleting the provisioned profile host from Satellite does not destroy the actual VM on the external compute resource. To destroy the VM when deleting the host entry on Satellite, navigate to Administer > Settings > Provisioning and configure this behavior using the destroy_vm_on_host_delete setting. If you do not destroy the associated VM and attempt to create a new VM with the same resource name later, it will fail because that VM name already exists in the external compute resource. You can still register the existing VM to Satellite using the standard host registration workflow you would use for any already provisioned host. 1.5. Required boot order for network boot For physical or virtual BIOS hosts Set the first booting device as boot configuration with network. Set the second booting device as boot from hard drive. Satellite manages TFTP boot configuration files, so hosts can be easily provisioned just by rebooting. For physical or virtual EFI hosts Set the first booting device as boot configuration with network. Depending on the EFI firmware type and configuration, the OS installer typically configures the OS boot loader as the first entry. To reboot into installer again, use the efibootmgr utility to switch back to boot from network.
null
https://docs.redhat.com/en/documentation/red_hat_satellite/6.15/html/provisioning_hosts/Introduction_to_Provisioning_provisioning
Chapter 2. Projects
Chapter 2. Projects 2.1. Working with projects A project allows a community of users to organize and manage their content in isolation from other communities. Note Projects starting with openshift- and kube- are default projects . These projects host cluster components that run as pods and other infrastructure components. As such, OpenShift Container Platform does not allow you to create projects starting with openshift- or kube- using the oc new-project command. Cluster administrators can create these projects using the oc adm new-project command. Note You cannot assign an SCC to pods created in one of the default namespaces: default , kube-system , kube-public , openshift-node , openshift-infra , and openshift . You cannot use these namespaces for running pods or services. 2.1.1. Creating a project You can use the OpenShift Container Platform web console or the OpenShift CLI ( oc ) to create a project in your cluster. 2.1.1.1. Creating a project by using the web console You can use the OpenShift Container Platform web console to create a project in your cluster. Note Projects starting with openshift- and kube- are considered critical by OpenShift Container Platform. As such, OpenShift Container Platform does not allow you to create projects starting with openshift- using the web console. Prerequisites Ensure that you have the appropriate roles and permissions to create projects, applications, and other workloads in OpenShift Container Platform. Procedure If you are using the Administrator perspective: Navigate to Home Projects . Click Create Project : In the Create Project dialog box, enter a unique name, such as myproject , in the Name field. Optional: Add the Display name and Description details for the project. Click Create . The dashboard for your project is displayed. Optional: Select the Details tab to view the project details. Optional: If you have adequate permissions for a project, you can use the Project Access tab to provide or revoke admin, edit, and view privileges for the project. If you are using the Developer perspective: Click the Project menu and select Create Project : Figure 2.1. Create project In the Create Project dialog box, enter a unique name, such as myproject , in the Name field. Optional: Add the Display name and Description details for the project. Click Create . Optional: Use the left navigation panel to navigate to the Project view and see the dashboard for your project. Optional: In the project dashboard, select the Details tab to view the project details. Optional: If you have adequate permissions for a project, you can use the Project Access tab of the project dashboard to provide or revoke admin, edit, and view privileges for the project. Additional resources Customizing the available cluster roles using the web console 2.1.1.2. Creating a project by using the CLI If allowed by your cluster administrator, you can create a new project. Note Projects starting with openshift- and kube- are considered critical by OpenShift Container Platform. As such, OpenShift Container Platform does not allow you to create Projects starting with openshift- or kube- using the oc new-project command. Cluster administrators can create these Projects using the oc adm new-project command. Note You cannot assign an SCC to pods created in one of the default namespaces: default , kube-system , kube-public , openshift-node , openshift-infra , and openshift . You cannot use these namespaces for running pods or services. Procedure Run: USD oc new-project <project_name> \ --description="<description>" --display-name="<display_name>" For example: USD oc new-project hello-openshift \ --description="This is an example project" \ --display-name="Hello OpenShift" Note The number of projects you are allowed to create might be limited by the system administrator. After your limit is reached, you might have to delete an existing project in order to create a new one. 2.1.2. Viewing a project You can use the OpenShift Container Platform web console or the OpenShift CLI ( oc ) to view a project in your cluster. 2.1.2.1. Viewing a project by using the web console You can view the projects that you have access to by using the OpenShift Container Platform web console. Procedure If you are using the Administrator perspective: Navigate to Home Projects in the navigation menu. Select a project to view. The Overview tab includes a dashboard for your project. Select the Details tab to view the project details. Select the YAML tab to view and update the YAML configuration for the project resource. Select the Workloads tab to see workloads in the project. Select the RoleBindings tab to view and create role bindings for your project. If you are using the Developer perspective: Navigate to the Project page in the navigation menu. Select All Projects from the Project drop-down menu at the top of the screen to list all of the projects in your cluster. Select a project to view. The Overview tab includes a dashboard for your project. Select the Details tab to view the project details. If you have adequate permissions for a project, select the Project access tab view and update the privileges for the project. 2.1.2.2. Viewing a project using the CLI When viewing projects, you are restricted to seeing only the projects you have access to view based on the authorization policy. Procedure To view a list of projects, run: USD oc get projects You can change from the current project to a different project for CLI operations. The specified project is then used in all subsequent operations that manipulate project-scoped content: USD oc project <project_name> 2.1.3. Providing access permissions to your project using the Developer perspective You can use the Project view in the Developer perspective to grant or revoke access permissions to your project. Prerequisites You have created a project. Procedure To add users to your project and provide Admin , Edit , or View access to them: In the Developer perspective, navigate to the Project page. Select your project from the Project menu. Select the Project Access tab. Click Add access to add a new row of permissions to the default ones. Figure 2.2. Project permissions Enter the user name, click the Select a role drop-down list, and select an appropriate role. Click Save to add the new permissions. You can also use: The Select a role drop-down list, to modify the access permissions of an existing user. The Remove Access icon, to completely remove the access permissions of an existing user to the project. Note Advanced role-based access control is managed in the Roles and Roles Binding views in the Administrator perspective. 2.1.4. Customizing the available cluster roles using the web console In the Developer perspective of the web console, the Project Project access page enables a project administrator to grant roles to users in a project. By default, the available cluster roles that can be granted to users in a project are admin, edit, and view. As a cluster administrator, you can define which cluster roles are available in the Project access page for all projects cluster-wide. You can specify the available roles by customizing the spec.customization.projectAccess.availableClusterRoles object in the Console configuration resource. Prerequisites You have access to the cluster as a user with the cluster-admin role. Procedure In the Administrator perspective, navigate to Administration Cluster settings . Click the Configuration tab. From the Configuration resource list, select Console operator.openshift.io . Navigate to the YAML tab to view and edit the YAML code. In the YAML code under spec , customize the list of available cluster roles for project access. The following example specifies the default admin , edit , and view roles: apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster # ... spec: customization: projectAccess: availableClusterRoles: - admin - edit - view Click Save to save the changes to the Console configuration resource. Verification In the Developer perspective, navigate to the Project page. Select a project from the Project menu. Select the Project access tab. Click the menu in the Role column and verify that the available roles match the configuration that you applied to the Console resource configuration. 2.1.5. Adding to a project You can add items to your project by using the +Add page in the Developer perspective. Prerequisites You have created a project. Procedure In the Developer perspective, navigate to the +Add page. Select your project from the Project menu. Click on an item on the +Add page and then follow the workflow. Note You can also use the search feature in the Add* page to find additional items to add to your project. Click * under Add at the top of the page and type the name of a component in the search field. 2.1.6. Checking the project status You can use the OpenShift Container Platform web console or the OpenShift CLI ( oc ) to view the status of your project. 2.1.6.1. Checking project status by using the web console You can review the status of your project by using the web console. Prerequisites You have created a project. Procedure If you are using the Administrator perspective: Navigate to Home Projects . Select a project from the list. Review the project status in the Overview page. If you are using the Developer perspective: Navigate to the Project page. Select a project from the Project menu. Review the project status in the Overview page. 2.1.6.2. Checking project status by using the CLI You can review the status of your project by using the OpenShift CLI ( oc ). Prerequisites You have installed the OpenShift CLI ( oc ). You have created a project. Procedure Switch to your project: USD oc project <project_name> 1 1 Replace <project_name> with the name of your project. Obtain a high-level overview of the project: USD oc status 2.1.7. Deleting a project You can use the OpenShift Container Platform web console or the OpenShift CLI ( oc ) to delete a project. When you delete a project, the server updates the project status to Terminating from Active . Then, the server clears all content from a project that is in the Terminating state before finally removing the project. While a project is in Terminating status, you cannot add new content to the project. Projects can be deleted from the CLI or the web console. 2.1.7.1. Deleting a project by using the web console You can delete a project by using the web console. Prerequisites You have created a project. You have the required permissions to delete the project. Procedure If you are using the Administrator perspective: Navigate to Home Projects . Select a project from the list. Click the Actions drop-down menu for the project and select Delete Project . Note The Delete Project option is not available if you do not have the required permissions to delete the project. In the Delete Project? pane, confirm the deletion by entering the name of your project. Click Delete . If you are using the Developer perspective: Navigate to the Project page. Select the project that you want to delete from the Project menu. Click the Actions drop-down menu for the project and select Delete Project . Note If you do not have the required permissions to delete the project, the Delete Project option is not available. In the Delete Project? pane, confirm the deletion by entering the name of your project. Click Delete . 2.1.7.2. Deleting a project by using the CLI You can delete a project by using the OpenShift CLI ( oc ). Prerequisites You have installed the OpenShift CLI ( oc ). You have created a project. You have the required permissions to delete the project. Procedure Delete your project: USD oc delete project <project_name> 1 1 Replace <project_name> with the name of the project that you want to delete. 2.2. Creating a project as another user Impersonation allows you to create a project as a different user. 2.2.1. API impersonation You can configure a request to the OpenShift Container Platform API to act as though it originated from another user. For more information, see User impersonation in the Kubernetes documentation. 2.2.2. Impersonating a user when you create a project You can impersonate a different user when you create a project request. Because system:authenticated:oauth is the only bootstrap group that can create project requests, you must impersonate that group. Procedure To create a project request on behalf of a different user: USD oc new-project <project> --as=<user> \ --as-group=system:authenticated --as-group=system:authenticated:oauth 2.3. Configuring project creation In OpenShift Container Platform, projects are used to group and isolate related objects. When a request is made to create a new project using the web console or oc new-project command, an endpoint in OpenShift Container Platform is used to provision the project according to a template, which can be customized. As a cluster administrator, you can allow and configure how developers and service accounts can create, or self-provision , their own projects. 2.3.1. About project creation The OpenShift Container Platform API server automatically provisions new projects based on the project template that is identified by the projectRequestTemplate parameter in the cluster's project configuration resource. If the parameter is not defined, the API server creates a default template that creates a project with the requested name, and assigns the requesting user to the admin role for that project. When a project request is submitted, the API substitutes the following parameters into the template: Table 2.1. Default project template parameters Parameter Description PROJECT_NAME The name of the project. Required. PROJECT_DISPLAYNAME The display name of the project. May be empty. PROJECT_DESCRIPTION The description of the project. May be empty. PROJECT_ADMIN_USER The user name of the administrating user. PROJECT_REQUESTING_USER The user name of the requesting user. Access to the API is granted to developers with the self-provisioner role and the self-provisioners cluster role binding. This role is available to all authenticated developers by default. 2.3.2. Modifying the template for new projects As a cluster administrator, you can modify the default project template so that new projects are created using your custom requirements. To create your own custom project template: Procedure Log in as a user with cluster-admin privileges. Generate the default project template: USD oc adm create-bootstrap-project-template -o yaml > template.yaml Use a text editor to modify the generated template.yaml file by adding objects or modifying existing objects. The project template must be created in the openshift-config namespace. Load your modified template: USD oc create -f template.yaml -n openshift-config Edit the project configuration resource using the web console or CLI. Using the web console: Navigate to the Administration Cluster Settings page. Click Configuration to view all configuration resources. Find the entry for Project and click Edit YAML . Using the CLI: Edit the project.config.openshift.io/cluster resource: USD oc edit project.config.openshift.io/cluster Update the spec section to include the projectRequestTemplate and name parameters, and set the name of your uploaded project template. The default name is project-request . Project configuration resource with custom project template apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestTemplate: name: <template_name> # ... After you save your changes, create a new project to verify that your changes were successfully applied. 2.3.3. Disabling project self-provisioning You can prevent an authenticated user group from self-provisioning new projects. Procedure Log in as a user with cluster-admin privileges. View the self-provisioners cluster role binding usage by running the following command: USD oc describe clusterrolebinding.rbac self-provisioners Example output Name: self-provisioners Labels: <none> Annotations: rbac.authorization.kubernetes.io/autoupdate=true Role: Kind: ClusterRole Name: self-provisioner Subjects: Kind Name Namespace ---- ---- --------- Group system:authenticated:oauth Review the subjects in the self-provisioners section. Remove the self-provisioner cluster role from the group system:authenticated:oauth . If the self-provisioners cluster role binding binds only the self-provisioner role to the system:authenticated:oauth group, run the following command: USD oc patch clusterrolebinding.rbac self-provisioners -p '{"subjects": null}' If the self-provisioners cluster role binding binds the self-provisioner role to more users, groups, or service accounts than the system:authenticated:oauth group, run the following command: USD oc adm policy \ remove-cluster-role-from-group self-provisioner \ system:authenticated:oauth Edit the self-provisioners cluster role binding to prevent automatic updates to the role. Automatic updates reset the cluster roles to the default state. To update the role binding using the CLI: Run the following command: USD oc edit clusterrolebinding.rbac self-provisioners In the displayed role binding, set the rbac.authorization.kubernetes.io/autoupdate parameter value to false , as shown in the following example: apiVersion: authorization.openshift.io/v1 kind: ClusterRoleBinding metadata: annotations: rbac.authorization.kubernetes.io/autoupdate: "false" # ... To update the role binding by using a single command: USD oc patch clusterrolebinding.rbac self-provisioners -p '{ "metadata": { "annotations": { "rbac.authorization.kubernetes.io/autoupdate": "false" } } }' Log in as an authenticated user and verify that it can no longer self-provision a project: USD oc new-project test Example output Error from server (Forbidden): You may not request a new project via this API. Consider customizing this project request message to provide more helpful instructions specific to your organization. 2.3.4. Customizing the project request message When a developer or a service account that is unable to self-provision projects makes a project creation request using the web console or CLI, the following error message is returned by default: You may not request a new project via this API. Cluster administrators can customize this message. Consider updating it to provide further instructions on how to request a new project specific to your organization. For example: To request a project, contact your system administrator at [email protected] . To request a new project, fill out the project request form located at https://internal.example.com/openshift-project-request . To customize the project request message: Procedure Edit the project configuration resource using the web console or CLI. Using the web console: Navigate to the Administration Cluster Settings page. Click Configuration to view all configuration resources. Find the entry for Project and click Edit YAML . Using the CLI: Log in as a user with cluster-admin privileges. Edit the project.config.openshift.io/cluster resource: USD oc edit project.config.openshift.io/cluster Update the spec section to include the projectRequestMessage parameter and set the value to your custom message: Project configuration resource with custom project request message apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestMessage: <message_string> # ... For example: apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestMessage: To request a project, contact your system administrator at [email protected]. # ... After you save your changes, attempt to create a new project as a developer or service account that is unable to self-provision projects to verify that your changes were successfully applied.
[ "oc new-project <project_name> --description=\"<description>\" --display-name=\"<display_name>\"", "oc new-project hello-openshift --description=\"This is an example project\" --display-name=\"Hello OpenShift\"", "oc get projects", "oc project <project_name>", "apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster spec: customization: projectAccess: availableClusterRoles: - admin - edit - view", "oc project <project_name> 1", "oc status", "oc delete project <project_name> 1", "oc new-project <project> --as=<user> --as-group=system:authenticated --as-group=system:authenticated:oauth", "oc adm create-bootstrap-project-template -o yaml > template.yaml", "oc create -f template.yaml -n openshift-config", "oc edit project.config.openshift.io/cluster", "apiVersion: config.openshift.io/v1 kind: Project metadata: spec: projectRequestTemplate: name: <template_name>", "oc describe clusterrolebinding.rbac self-provisioners", "Name: self-provisioners Labels: <none> Annotations: rbac.authorization.kubernetes.io/autoupdate=true Role: Kind: ClusterRole Name: self-provisioner Subjects: Kind Name Namespace ---- ---- --------- Group system:authenticated:oauth", "oc patch clusterrolebinding.rbac self-provisioners -p '{\"subjects\": null}'", "oc adm policy remove-cluster-role-from-group self-provisioner system:authenticated:oauth", "oc edit clusterrolebinding.rbac self-provisioners", "apiVersion: authorization.openshift.io/v1 kind: ClusterRoleBinding metadata: annotations: rbac.authorization.kubernetes.io/autoupdate: \"false\"", "oc patch clusterrolebinding.rbac self-provisioners -p '{ \"metadata\": { \"annotations\": { \"rbac.authorization.kubernetes.io/autoupdate\": \"false\" } } }'", "oc new-project test", "Error from server (Forbidden): You may not request a new project via this API.", "You may not request a new project via this API.", "oc edit project.config.openshift.io/cluster", "apiVersion: config.openshift.io/v1 kind: Project metadata: spec: projectRequestMessage: <message_string>", "apiVersion: config.openshift.io/v1 kind: Project metadata: spec: projectRequestMessage: To request a project, contact your system administrator at [email protected]." ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html/building_applications/projects
Chapter 45. Configuring IBM WebSphere Application Server for KIE Server
Chapter 45. Configuring IBM WebSphere Application Server for KIE Server Before you deploy KIE Server with IBM WebSphere Application Server, you must configure system properties, security settings, JMS requirements, and other properties on IBM WebSphere. These configurations promote an optimal integration with KIE Server. Prerequisites IBM WebSphere Application Server is installed and running. You are logged in to the WebSphere Integrated Solutions Console. 45.1. Enabling administrative security You must enable administrative security in the WebSphere Integrated Solutions Console so that you have the required permissions to create users and groups. Procedure In the WebSphere Integrated Solutions Console, click Security Global Security and ensure that the option Enable Application Security is selected. This may already be selected and overridden at the server level. Click Security Configuration Wizard and click . Select the repository that contains the user information. For example, select Federated repositories for local configurations. Click Enter the Primary administrative user name and Password . Click and then click Finish . Click Save in the Messages window to save your changes to the primary configuration. Figure 45.1. Save security changes In your command terminal, navigate to the IBM WebSphere Application Server /bin directory location that you specified during installation, and run the following commands to stop and restart IBM WebSphere to apply the security changes: Replace <SERVER_NAME> with the IBM WebSphere Application Server name defined in Servers Server Types IBM WebSphere Application Servers of the WebSphere Integrated Solutions Console. 45.2. Configuring Java Message Service (JMS) The Java Message Service (JMS) is a Java API that KIE Server uses to exchange messages with other application servers such as Oracle WebLogic Server and IBM WebSphere Application Server. You must configure your application server to send and receive JMS messages through KIE Server to ensure collaboration between the two servers. 45.2.1. Create a service bus and add IBM WebSphere Application Server You must create a service bus and add the IBM WebSphere Application Server as a member in order to use JMS. Procedure In the WebSphere Integrated Solutions Console, navigate to Service Integration Buses New . Enter a new bus name and clear the Bus Security option. Click and then Finish to create the service bus. Select the service bus that you created. Under Topology , select Bus Members Add . In the Add a New Bus Member wizard, choose the IBM WebSphere Application Server and the type of message store for persistence. You can also specify the properties of the message store. Click Finish to add the new bus member. 45.2.2. Create JMS connection factories To enable messaging with KIE Server, you must create certain JMS connection factories for sending and receiving messages. Prerequisites You have created a service bus for IBM WebSphere Application Server. Procedure In the WebSphere Integrated Solutions Console, navigate to Resources JMS Connection Factories . Select the correct scope and click New . Select the Default Messaging Provider option and click OK . For each of the following required connection factories, enter the name of the connection factory (for example, KIE.SERVER.REQUEST ) and the JNDI name (for example, jms/cf/KIE.SERVER.REQUEST ), and then select the service bus from the Bus Name drop-down list. Leave the default values for the remaining options. Click Apply and then click Save to save the changes to the primary configuration, and repeat for each required factory. 45.2.2.1. JMS connection factories for KIE Server The following table lists the required Java Message Service (JMS) connection factories that enable JMS messaging with KIE Server: Table 45.1. Required JMS connection factories for KIE Server Name Default value Used for KIE.SERVER.REQUEST jms/cf/KIE.SERVER.REQUEST Sending all requests to KIE Server KIE.SERVER.RESPONSE jms/cf/KIE.SERVER.RESPONSE Receiving all responses produced by KIE Server 45.2.3. Create JMS queues JMS queues are the destination end points for point-to-point messaging. You must create certain JMS queues to enable JMS messaging with KIE Server. Prerequisites You have created a service bus for IBM WebSphere Application Server. Procedure In the WebSphere Integrated Solutions Console, navigate to Resources JMS Queues . Select the correct scope and click New . Select the Default Messaging Provider option and click OK . For each of the following required queues, enter the name of the queue (for example, KIE.SERVER.REQUEST ) and the JNDI name (for example, jms/KIE.SERVER.REQUEST ), and then select the service bus from the Bus Name drop-down list. From the Queue Name drop-down list, select the Create Service Integration Bus Destination , enter a unique identifier, and select the bus member that you created previously. Click Apply and then click Save to save the changes to the primary configuration, and repeat for each required queue. 45.2.3.1. JMS queues for KIE Server The following table lists the required Java Message Service (JMS) queues that enable JMS messaging with KIE Server: Table 45.2. Required JMS queues for KIE Server Name Default value Used for KIE.SERVER.REQUEST jms/KIE.SERVER.REQUEST Sending all requests to KIE Server KIE.SERVER.RESPONSE jms/KIE.SERVER.RESPONSE Receiving all responses produced by KIE Server 45.2.4. Create JMS activation specifications A JMS activation specification is required in order to bridge the queue and the message-driven bean that enables JMS. Prerequisites You have created a service bus for IBM WebSphere Application Server. You have created JMS queues. Procedure In the WebSphere Integrated Solutions Console, navigate to Resources JMS Activation Specifications . Select the correct scope and click New . Select the Default Messaging Provider option and click OK . For each of the following required activation specifications, enter the name of the activation specification (for example, KIE.SERVER.REQUEST ) and the JNDI name (for example, jms/activation/KIE.SERVER.REQUEST ), and then select the service bus from the Bus Name drop-down list. From the Destination Type drop-down list, select Queue and enter the name of the corresponding queue as a Destination lookup (for example, jms/KIE.SERVER.REQUEST ). Click Apply and then click Save to save the changes to the primary configuration, and repeat for each required activation specification. 45.2.4.1. JMS activation specifications for KIE Server The following table lists the required Java Message Service (JMS) activation specifications that enable JMS messaging with KIE Server: Table 45.3. Required JMS activation specifications for KIE Server Name Default value Used for KIE.SERVER.REQUEST jms/activation/KIE.SERVER.REQUEST Sending all requests to KIE Server KIE.SERVER.RESPONSE jms/activation/KIE.SERVER.RESPONSE Receiving all responses produced by KIE Server 45.3. Setting system properties in IBM WebSphere Application Server Set the system properties listed in this section on your IBM WebSphere Application Server before you deploy KIE Server. Procedure In the WebSphere Integrated Solutions Console, navigate to Servers Server Types IBM WebSphere Application Servers . In the list of application servers, choose the server on which you are going to deploy KIE Server. Under the Server Infrastructure , click Java and Process Management Process Definition . Figure 45.2. WebSphere configuration page Under Additional Properties , click Java Virtual Machine . Figure 45.3. Process definition configuration page This opens the configuration properties for the JVM that is used to start IBM WebSphere. Set both the Initial heap size and Maximum heap size to 2048 and click Apply to increase the Java Virtual Machine (JVM) memory size. KIE Server has been tested with these values. If you do not increase the JVM memory size, IBM WebSphere Application Server freezes or causes deployment errors when deploying KIE Server. Under Additional Properties , click Custom Properties . Click New Custom JVM Properties and add the following properties to IBM WebSphere: Table 45.4. System properties for KIE Server Name Value Description kie.server.jms.queues.response jms/KIE.SERVER.RESPONSE The JNDI name of JMS queue for responses used by KIE Server. org.kie.server.domain WSLogin JAAS LoginContext domain used to authenticate users when using JMS. org.jbpm.server.ext.disabled true Disables Business Central features, which are not supported in RHDM. If not set, KIE Server will work, but will show error messages during start up. org.jbpm.ui.server.ext.disabled true Disables Business Central features, which are not supported in RHDM. If not set, KIE Server will work, but will show error messages during start up. org.jbpm.case.server.ext.disabled true Disables Business Central features, which are not supported in RHDM. If not set, KIE Server will work, but will show error messages during start up. org.jboss.logging.provider jdk This property is only required where a CA SiteMinder TAI (SMTAI) is installed in the environment. Using this property forces Hibernate to use JDK instead of log4j for logging within Dashbuilder. CA SiteMinder TAI (SMTAI) contains an old version of log4j , which causes conflicts. Click Save to save the changes to the primary configuration. 45.4. Stopping and restarting IBM WebSphere Application Server After you have configured all required system properties in IBM WebSphere Application Server, stop and restart the IBM server to ensure that the configurations are applied. Procedure In your command terminal, navigate to the IBM WebSphere Application Server /bin directory location that you specified during installation, and run the following commands to stop and restart IBM WebSphere to apply the configuration changes: Replace <SERVER_NAME> with the IBM WebSphere Application Server name defined in Servers Server Types IBM WebSphere Application Servers of the WebSphere Integrated Solutions Console.
[ "sudo ./stopServer.sh <SERVER_NAME>", "sudo ./startServer.sh <SERVER_NAME>", "sudo ./stopServer.sh <SERVER_NAME>", "sudo ./startServer.sh <SERVER_NAME>" ]
https://docs.redhat.com/en/documentation/red_hat_decision_manager/7.13/html/installing_and_configuring_red_hat_decision_manager/was-configure-proc
Chapter 15. Accessing the RADOS Object Gateway S3 endpoint
Chapter 15. Accessing the RADOS Object Gateway S3 endpoint Users can access the RADOS Object Gateway (RGW) endpoint directly. In versions of Red Hat OpenShift Data Foundation, RGW service needed to be manually exposed to create RGW public route. As of OpenShift Data Foundation version 4.7, the RGW route is created by default and is named rook-ceph-rgw-ocs-storagecluster-cephobjectstore .
null
https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.18/html/managing_hybrid_and_multicloud_resources/Accessing-the-RADOS-Object-Gateway-S3-endpoint_rhodf
Chapter 2. Reference
Chapter 2. Reference This chapter provides a list of Hammer usage statements. These usage statements are current to the versions of Hammer and its components released for Satellite 6.11. 2.1. hammer 2.2. hammer activation-key Manipulate activation keys 2.2.1. hammer activation-key add-host-collection Associate a resource 2.2.2. hammer activation-key add-subscription Add subscription 2.2.3. hammer activation-key content-override Override product content defaults 2.2.4. hammer activation-key copy Copy an activation key 2.2.5. hammer activation-key create Create an activation key 2.2.6. hammer activation-key delete Destroy an activation key 2.2.7. hammer activation-key host-collections List associated host collections 2.2.8. hammer activation-key info Show an activation key 2.2.9. hammer activation-key list List activation keys 2.2.10. hammer activation-key product-content List associated products 2.2.11. hammer activation-key remove-host-collection Disassociate a resource 2.2.12. hammer activation-key remove-subscription Remove subscription 2.2.13. hammer activation-key subscriptions List associated subscriptions 2.2.14. hammer activation-key update Update an activation key 2.3. hammer admin Administrative server-side tasks 2.3.1. hammer admin logging Logging verbosity level setup 2.4. hammer ansible Manage foreman ansible 2.4.1. hammer ansible roles Manage ansible roles 2.4.1.1. hammer ansible roles delete Deletes Ansible role 2.4.1.2. hammer ansible roles fetch Fetch Ansible roles available to be synced 2.4.1.3. hammer ansible roles import DEPRECATED: Import Ansible roles 2.4.1.4. hammer ansible roles info Show role 2.4.1.5. hammer ansible roles list List Ansible roles 2.4.1.6. hammer ansible roles obsolete DEPRECATED: Obsolete Ansible roles 2.4.1.7. hammer ansible roles play-hostgroups Runs all Ansible roles on hostgroups 2.4.1.8. hammer ansible roles play-hosts Runs all Ansible roles on hosts 2.4.1.9. hammer ansible roles sync Sync Ansible roles 2.4.2. hammer ansible variables Manage ansible variables 2.4.2.1. hammer ansible variables add-matcher Create an override value for a specific ansible variable 2.4.2.2. hammer ansible variables create Create Ansible variable 2.4.2.3. hammer ansible variables delete Deletes Ansible variable 2.4.2.4. hammer ansible variables import DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles 2.4.2.5. hammer ansible variables info Show variable 2.4.2.6. hammer ansible variables list List Ansible variables 2.4.2.7. hammer ansible variables obsolete DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles 2.4.2.8. hammer ansible variables remove-matcher Destroy an override value 2.4.2.9. hammer ansible variables update Updates Ansible variable 2.5. hammer architecture Manipulate architectures 2.5.1. hammer architecture add-operatingsystem Associate an operating system 2.5.2. hammer architecture create Create an architecture 2.5.3. hammer architecture delete Delete an architecture 2.5.4. hammer architecture info Show an architecture 2.5.5. hammer architecture list List all architectures 2.5.6. hammer architecture remove-operatingsystem Disassociate an operating system 2.5.7. hammer architecture update Update an architecture 2.6. hammer arf-report Manipulate compliance reports 2.6.1. hammer arf-report delete Delete an ARF Report 2.6.2. hammer arf-report download Download bzipped ARF report 2.6.3. hammer arf-report download-html Download ARF report in HTML 2.6.4. hammer arf-report info Show an ARF report 2.6.5. hammer arf-report list List ARF reports 2.7. hammer audit Search audit trails. 2.7.1. hammer audit info Show an audit 2.7.2. hammer audit list List all audits 2.8. hammer auth Foreman connection login/logout 2.8.1. hammer auth login Set credentials 2.8.1.1. hammer auth login basic provide username and password 2.8.1.2. hammer auth login oauth supports for both with/without 2fa 2.8.2. hammer auth logout Wipe your credentials 2.8.3. hammer auth status Information about current connections 2.9. hammer auth-source Manipulate auth sources 2.9.1. hammer auth-source external Manage external auth sources 2.9.1.1. hammer auth-source external info Show an external authentication source 2.9.1.2. hammer auth-source external list List external authentication sources 2.9.1.3. hammer auth-source external update Update organization and location for Auth Source 2.9.2. hammer auth-source ldap Manage LDAP auth sources 2.9.2.1. hammer auth-source ldap create Create an LDAP authentication source 2.9.2.2. hammer auth-source ldap delete Delete an LDAP authentication source 2.9.2.3. hammer auth-source ldap info Show an LDAP authentication source 2.9.2.4. hammer auth-source ldap list List all LDAP authentication sources 2.9.2.5. hammer auth-source ldap update Update an LDAP authentication source 2.9.3. hammer auth-source list List all auth sources 2.10. hammer bookmark Manage bookmarks 2.10.1. hammer bookmark create Create a bookmark 2.10.2. hammer bookmark delete Delete a bookmark 2.10.3. hammer bookmark info Show a bookmark 2.10.4. hammer bookmark list List all bookmarks 2.10.5. hammer bookmark update Update a bookmark 2.11. hammer bootdisk Download boot disks 2.11.1. hammer bootdisk generic Download generic image 2.11.2. hammer bootdisk host Download host image 2.11.3. hammer bootdisk subnet Download subnet generic image 2.12. hammer capsule Manipulate capsule 2.12.1. hammer capsule content Manage the capsule content 2.12.1.1. hammer capsule content add-lifecycle-environment Add lifecycle environments to the capsule 2.12.1.2. hammer capsule content available-lifecycle-environments List the lifecycle environments not attached to the capsule 2.12.1.3. hammer capsule content cancel-synchronization Cancel running capsule synchronization 2.12.1.4. hammer capsule content info Get current capsule synchronization status 2.12.1.5. hammer capsule content lifecycle-environments List the lifecycle environments attached to the capsule 2.12.1.6. hammer capsule content remove-lifecycle-environment Remove lifecycle environments from the capsule 2.12.1.7. hammer capsule content synchronization-status Get current capsule synchronization status 2.12.1.8. hammer capsule content synchronize Synchronize the content to the capsule 2.12.2. hammer capsule create Create a capsule 2.12.3. hammer capsule delete Delete a capsule 2.12.4. hammer capsule info Show a capsule 2.12.5. hammer capsule list List all capsules 2.12.6. hammer capsule refresh-features Refresh capsule features 2.12.7. hammer capsule update Update a capsule 2.13. hammer compute-profile Manipulate compute profiles 2.13.1. hammer compute-profile create Create a compute profile 2.13.2. hammer compute-profile delete Delete a compute profile 2.13.3. hammer compute-profile info Show a compute profile 2.13.4. hammer compute-profile list List of compute profiles 2.13.5. hammer compute-profile update Update a compute profile 2.13.6. hammer compute-profile values Create update and delete Compute profile values 2.13.6.1. hammer compute-profile values add-interface Add interface for Compute Profile 2.13.6.2. hammer compute-profile values add-volume Add volume for Compute Profile 2.13.6.3. hammer compute-profile values create Create compute profile set of values 2.13.6.4. hammer compute-profile values remove-interface Remove compute profile interface 2.13.6.5. hammer compute-profile values remove-volume Remove compute profile volume 2.13.6.6. hammer compute-profile values update Update compute profile values 2.13.6.7. hammer compute-profile values update-interface Update compute profile interface 2.13.6.8. hammer compute-profile values update-volume Update compute profile volume 2.14. hammer compute-resource Manipulate compute resources 2.14.1. hammer compute-resource associate-vms Associate VMs to Hosts 2.14.2. hammer compute-resource clusters List available clusters for a compute resource 2.14.3. hammer compute-resource create Create a compute resource 2.14.4. hammer compute-resource delete Delete a compute resource 2.14.5. hammer compute-resource flavors List available flavors for a compute resource 2.14.6. hammer compute-resource folders List available folders for a compute resource 2.14.7. hammer compute-resource image View and manage compute resource's images 2.14.7.1. hammer compute-resource image available Show images available for addition 2.14.7.2. hammer compute-resource image create Create an image 2.14.7.3. hammer compute-resource image delete Delete an image 2.14.7.4. hammer compute-resource image info Show an image 2.14.7.5. hammer compute-resource image list List all images for a compute resource 2.14.7.6. hammer compute-resource image update Update an image 2.14.8. hammer compute-resource images List available images for a compute resource 2.14.9. hammer compute-resource info Show a compute resource 2.14.10. hammer compute-resource list List all compute resources 2.14.11. hammer compute-resource networks List available networks for a compute resource 2.14.12. hammer compute-resource resource-pools List resource pools for a compute resource cluster 2.14.13. hammer compute-resource security-groups List available security groups for a compute resource 2.14.14. hammer compute-resource storage-domains List storage domains for a compute resource 2.14.15. hammer compute-resource storage-pods List storage pods for a compute resource 2.14.16. hammer compute-resource update Update a compute resource 2.14.17. hammer compute-resource virtual-machine View and manage compute resource's virtual machines 2.14.17.1. hammer compute-resource virtual-machine delete Delete a Virtual Machine 2.14.17.2. hammer compute-resource virtual-machine info Show a virtual machine 2.14.17.3. hammer compute-resource virtual-machine power Power a Virtual Machine 2.14.18. hammer compute-resource virtual-machines List available virtual machines for a compute resource 2.14.19. hammer compute-resource vnic-profiles List available vnic profiles for a compute resource, for RHEV only 2.14.20. hammer compute-resource zones List available zone for a compute resource 2.15. hammer config-report Browse and read reports 2.15.1. hammer config-report delete Delete a report 2.15.2. hammer config-report info Show a report 2.15.3. hammer config-report list List all reports 2.16. hammer content-credentials Manipulate content credentials on the server 2.16.1. hammer content-credentials create Create a Content Credential 2.16.2. hammer content-credentials delete Destroy a Content Credential 2.16.3. hammer content-credentials info Show a Content Credential 2.16.4. hammer content-credentials list List Content Credentials 2.16.5. hammer content-credentials update Update a Content Credential 2.17. hammer content-export Prepare content for export to a disconnected Katello 2.17.1. hammer content-export complete Prepare content for a full export to a disconnected Katello 2.17.1.1. hammer content-export complete library Performs a full export of the organization's library environment 2.17.1.2. hammer content-export complete repository Performs a full export of a repository 2.17.1.3. hammer content-export complete version Performs a full export a content view version 2.17.2. hammer content-export generate-metadata Writes export metadata to disk for use by the importing Katello. This command only needs to be used if the export was performed asynchronously or if the metadata was lost 2.17.3. hammer content-export incremental Prepare content for an incremental export to a disconnected Katello 2.17.3.1. hammer content-export incremental library Performs an incremental export of the organization's library environment 2.17.3.2. hammer content-export incremental repository Performs an incremental export of a repository 2.17.3.3. hammer content-export incremental version Performs an incremental export of a content view version 2.17.4. hammer content-export list View content view export histories 2.18. hammer content-import Import content from an upstream archive. 2.18.1. hammer content-import library Imports a content archive to an organization's library lifecycle environment 2.18.2. hammer content-import list View content view import histories 2.18.3. hammer content-import repository Imports a repository 2.18.4. hammer content-import version Imports a content archive to a content view version 2.19. hammer content-units Manipulate content units 2.19.1. hammer content-units info Show a content unit 2.19.2. hammer content-units list List content_units 2.20. hammer content-view Manipulate content views 2.20.1. hammer content-view add-repository Associate a resource 2.20.2. hammer content-view add-version Add a content view version to a composite view 2.20.3. hammer content-view component View and manage components 2.20.3.1. hammer content-view component add Add components to the content view 2.20.3.2. hammer content-view component list List components attached to this content view 2.20.3.3. hammer content-view component remove Remove components from the content view 2.20.3.4. hammer content-view component update Update a component associated with the content view 2.20.4. hammer content-view copy Copy a content view 2.20.5. hammer content-view create Create a content view 2.20.6. hammer content-view delete Delete a content view 2.20.7. hammer content-view filter View and manage filters 2.20.7.1. hammer content-view filter add-repository Associate a resource 2.20.7.2. hammer content-view filter create create a filter for a content view 2.20.7.3. hammer content-view filter delete delete a filter 2.20.7.4. hammer content-view filter info show filter info 2.20.7.5. hammer content-view filter list list filters 2.20.7.6. hammer content-view filter remove-repository Disassociate a resource 2.20.7.7. hammer content-view filter rule View and manage filter rules 2.20.7.7.1. hammer content-view filter rule create Create a filter rule. The parameters included should be based upon the filter type. 2.20.7.7.2. hammer content-view filter rule delete Delete a filter rule 2.20.7.7.3. hammer content-view filter rule info Show filter rule info 2.20.7.7.4. hammer content-view filter rule list List filter rules 2.20.7.7.5. hammer content-view filter rule update Update a filter rule. The parameters included should be based upon the filter type. 2.20.7.8. hammer content-view filter update update a filter 2.20.8. hammer content-view info Show a content view 2.20.9. hammer content-view list List content views 2.20.10. hammer content-view publish Publish a content view 2.20.11. hammer content-view purge Delete old versions of a content view 2.20.12. hammer content-view remove Remove versions and/or environments from a content view and reassign systems and keys 2.20.13. hammer content-view remove-from-environment Remove a content view from an environment 2.20.14. hammer content-view remove-repository Disassociate a resource 2.20.15. hammer content-view remove-version Remove a content view version from a composite view 2.20.16. hammer content-view update Update a content view 2.20.17. hammer content-view version View and manage content view versions 2.20.17.1. hammer content-view version delete Remove content view version 2.20.17.2. hammer content-view version incremental-update Perform an Incremental Update on one or more Content View Versions 2.20.17.3. hammer content-view version info Show content view version 2.20.17.4. hammer content-view version list List content view versions 2.20.17.5. hammer content-view version promote Promote a content view version 2.20.17.6. hammer content-view version republish-repositories Forces a republish of the version's repositories' metadata 2.20.17.7. hammer content-view version update Update a content view version 2.21. hammer deb-package Manipulate deb packages 2.21.1. hammer deb-package info Show a deb package 2.21.2. hammer deb-package list List deb packages 2.22. hammer defaults Defaults management 2.22.1. hammer defaults add Add a default parameter to config 2.22.2. hammer defaults delete Delete a default param 2.22.3. hammer defaults list List all the default parameters 2.22.4. hammer defaults providers List all the providers 2.23. hammer discovery Manipulate discovered hosts. 2.23.1. hammer discovery auto-provision Auto provision a host 2.23.2. hammer discovery delete Delete a discovered host 2.23.3. hammer discovery facts List all fact values 2.23.4. hammer discovery info Show a discovered host 2.23.5. hammer discovery list List all discovered hosts 2.23.6. hammer discovery provision Provision a discovered host 2.23.7. hammer discovery reboot Reboot a host 2.23.8. hammer discovery refresh-facts Refresh the facts of a host 2.24. hammer discovery-rule Manipulate discovered rules. 2.24.1. hammer discovery-rule create Create a discovery rule 2.24.2. hammer discovery-rule delete Delete a rule 2.24.3. hammer discovery-rule info Show a discovery rule 2.24.4. hammer discovery-rule list List all discovery rules 2.24.5. hammer discovery-rule update Update a rule 2.25. hammer docker Manipulate docker content 2.25.1. hammer docker manifest Manage docker manifests 2.25.1.1. hammer docker manifest info Show a docker manifest 2.25.1.2. hammer docker manifest list List docker_manifests 2.25.2. hammer docker tag Manage docker tags 2.25.2.1. hammer docker tag info Show a docker tag 2.25.2.2. hammer docker tag list List docker_tags 2.26. hammer domain Manipulate domains 2.26.1. hammer domain create Create a domain 2.26.2. hammer domain delete Delete a domain 2.26.3. hammer domain delete-parameter Delete parameter for a domain 2.26.4. hammer domain info Show a domain 2.26.5. hammer domain list List of domains 2.26.6. hammer domain set-parameter Create or update parameter for a domain 2.26.7. hammer domain update Update a domain 2.27. hammer erratum Manipulate errata 2.27.1. hammer erratum info Show an erratum 2.27.2. hammer erratum list List errata 2.28. hammer export-templates Export templates to a git repo or a directory on the server 2.29. hammer fact Search facts 2.29.1. hammer fact list List all fact values 2.30. hammer file Manipulate files 2.30.1. hammer file info Show a file 2.30.2. hammer file list List files 2.31. hammer filter Manage permission filters 2.31.1. hammer filter available-permissions List all permissions 2.31.2. hammer filter available-resources List available resource types 2.31.3. hammer filter create Create a filter 2.31.4. hammer filter delete Delete a filter 2.31.5. hammer filter info Show a filter 2.31.6. hammer filter list List all filters 2.31.7. hammer filter update Update a filter 2.32. hammer foreign-input-set Manage foreign input sets 2.32.1. hammer foreign-input-set create Create a foreign input set 2.32.2. hammer foreign-input-set delete Delete a foreign input set 2.32.3. hammer foreign-input-set info Show foreign input set details 2.32.4. hammer foreign-input-set list List foreign input sets 2.32.5. hammer foreign-input-set update Update a foreign input set 2.33. hammer full-help Print help for all hammer commands 2.34. hammer global-parameter Manipulate global parameters 2.34.1. hammer global-parameter delete Delete a global parameter 2.34.2. hammer global-parameter list List all global parameters 2.34.3. hammer global-parameter set Set a global parameter 2.35. hammer host Manipulate hosts 2.35.1. hammer host ansible-roles Manage Ansible roles on a host 2.35.1.1. hammer host ansible-roles assign Assigns Ansible roles to a host 2.35.1.2. hammer host ansible-roles list List all Ansible roles for a host 2.35.1.3. hammer host ansible-roles play Runs all Ansible roles on a host 2.35.2. hammer host boot Boot host from specified device 2.35.3. hammer host config-reports List all reports 2.35.4. hammer host create Create a host 2.35.5. hammer host deb-package Manage deb packages on your hosts 2.35.5.1. hammer host deb-package list List deb packages installed on the host 2.35.6. hammer host delete Delete a host 2.35.7. hammer host delete-parameter Delete parameter for a host 2.35.8. hammer host disassociate Disassociate a host 2.35.9. hammer host enc-dump Dump host's ENC YAML 2.35.10. hammer host errata Manage errata on your hosts 2.35.10.1. hammer host errata apply Schedule errata for installation using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.10.2. hammer host errata info Retrieve a single errata for a host 2.35.10.3. hammer host errata list List errata available for the content host 2.35.10.4. hammer host errata recalculate Force regenerate applicability. 2.35.11. hammer host facts List all fact values 2.35.12. hammer host info Show a host 2.35.13. hammer host interface View and manage host's network interfaces 2.35.13.1. hammer host interface create Create an interface on a host 2.35.13.2. hammer host interface delete Delete a host's interface 2.35.13.3. hammer host interface info Show an interface for host 2.35.13.4. hammer host interface list List all interfaces for host 2.35.13.5. hammer host interface update Update a host's interface 2.35.14. hammer host list List all hosts 2.35.15. hammer host package Manage packages on your hosts 2.35.15.1. hammer host package install Install packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.15.2. hammer host package list List packages installed on the host 2.35.15.3. hammer host package remove Uninstall packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.15.4. hammer host package upgrade Update packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.15.5. hammer host package upgrade-all Update packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.16. hammer host package-group Manage package-groups on your hosts 2.35.16.1. hammer host package-group install Install packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.16.2. hammer host package-group remove Uninstall packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. 2.35.17. hammer host policies-enc View policies ENC for host 2.35.18. hammer host reboot Reboot a host 2.35.19. hammer host rebuild-config Rebuild orchestration related configurations for host 2.35.20. hammer host reports List all reports 2.35.21. hammer host reset Reset a host 2.35.22. hammer host set-parameter Create or append a parameter for a host 2.35.23. hammer host start Power a host on 2.35.24. hammer host status Get status of host 2.35.25. hammer host stop Power a host off 2.35.26. hammer host subscription Manage subscription information on your hosts 2.35.26.1. hammer host subscription attach Add a subscription to a host 2.35.26.2. hammer host subscription auto-attach Trigger an auto-attach of subscriptions 2.35.26.3. hammer host subscription content-override Override product content defaults 2.35.26.4. hammer host subscription product-content List associated products 2.35.26.5. hammer host subscription register Register a host with subscription and information 2.35.26.6. hammer host subscription remove 2.35.26.7. hammer host subscription unregister Unregister the host as a subscription consumer 2.35.27. hammer host traces List traces on your hosts 2.35.27.1. hammer host traces list List services that need restarting on the host 2.35.27.2. hammer host traces resolve Resolve traces 2.35.28. hammer host update Update a host 2.36. hammer host-collection Manipulate host collections 2.36.1. hammer host-collection add-host Add host to the host collection 2.36.2. hammer host-collection copy Copy a host collection 2.36.3. hammer host-collection create Create a host collection 2.36.4. hammer host-collection delete Destroy a host collection 2.36.5. hammer host-collection erratum Manipulate errata for a host collection 2.36.5.1. hammer host-collection erratum install Install errata on content hosts contained within a host collection 2.36.6. hammer host-collection hosts List all hosts 2.36.7. hammer host-collection info Show a host collection 2.36.8. hammer host-collection list List host collections 2.36.9. hammer host-collection package Manipulate packages for a host collection 2.36.9.1. hammer host-collection package install Install packages on content hosts contained within a host collection 2.36.9.2. hammer host-collection package remove Remove packages on content hosts contained within a host collection 2.36.9.3. hammer host-collection package update Update packages on content hosts contained within a host collection 2.36.10. hammer host-collection package-group Manipulate package-groups for a host collection 2.36.10.1. hammer host-collection package-group install Install package-groups on content hosts contained within a host collection 2.36.10.2. hammer host-collection package-group remove Remove package-groups on content hosts contained within a host collection 2.36.10.3. hammer host-collection package-group update Update package-groups on content hosts contained within a host collection 2.36.11. hammer host-collection remove-host Remove hosts from the host collection 2.36.12. hammer host-collection update Update a host collection 2.37. hammer host-registration Host Registration 2.37.1. hammer host-registration generate-command Generate global registration command 2.38. hammer hostgroup Manipulate hostgroups 2.38.1. hammer hostgroup ansible-roles Manage Ansible roles on a hostgroup 2.38.1.1. hammer hostgroup ansible-roles assign Assigns Ansible roles to a hostgroup 2.38.1.2. hammer hostgroup ansible-roles list List all Ansible roles for a hostgroup 2.38.1.3. hammer hostgroup ansible-roles play Runs all Ansible roles on a hostgroup 2.38.2. hammer hostgroup create Create a host group 2.38.3. hammer hostgroup delete Delete a host group 2.38.4. hammer hostgroup delete-parameter Delete parameter for a hostgroup 2.38.5. hammer hostgroup info Show a host group 2.38.6. hammer hostgroup list List all host groups 2.38.7. hammer hostgroup rebuild-config Rebuild orchestration config 2.38.8. hammer hostgroup set-parameter Create or update parameter for a hostgroup 2.38.9. hammer hostgroup update Update a host group 2.39. hammer http-proxy Manipulate http proxies 2.39.1. hammer http-proxy create Create an HTTP Proxy 2.39.2. hammer http-proxy delete Delete an HTTP Proxy 2.39.3. hammer http-proxy info Show an HTTP Proxy 2.39.4. hammer http-proxy list List of HTTP Proxies 2.39.5. hammer http-proxy update Update an HTTP Proxy 2.40. hammer import-templates Import templates from a git repo or a directory on the server 2.41. hammer job-invocation Manage job invocations 2.41.1. hammer job-invocation cancel Cancel the job 2.41.2. hammer job-invocation create Create a job invocation 2.41.3. hammer job-invocation info Show job invocation 2.41.4. hammer job-invocation list List job invocations 2.41.5. hammer job-invocation output View the output for a host 2.41.6. hammer job-invocation rerun Rerun the job 2.42. hammer job-template Manage job templates 2.42.1. hammer job-template create Create a job template 2.42.2. hammer job-template delete Delete a job template 2.42.3. hammer job-template dump View job template content 2.42.4. hammer job-template export Export a template including all metadata 2.42.5. hammer job-template import Import a job template from ERB 2.42.6. hammer job-template info Show job template details 2.42.7. hammer job-template list List job templates 2.42.8. hammer job-template update Update a job template 2.43. hammer lifecycle-environment Manipulate lifecycle_environments on the server 2.43.1. hammer lifecycle-environment create Create an environment 2.43.2. hammer lifecycle-environment delete Destroy an environment 2.43.3. hammer lifecycle-environment info Show an environment 2.43.4. hammer lifecycle-environment list List environments in an organization 2.43.5. hammer lifecycle-environment paths List environment paths 2.43.6. hammer lifecycle-environment update Update an environment 2.44. hammer location Manipulate locations 2.44.1. hammer location add-compute-resource Associate a compute resource 2.44.2. hammer location add-domain Associate a domain 2.44.3. hammer location add-hostgroup Associate a hostgroup 2.44.4. hammer location add-medium Associate a medium 2.44.5. hammer location add-organization Associate an organization 2.44.6. hammer location add-provisioning-template Associate provisioning templates 2.44.7. hammer location add-smart-proxy Associate a smart proxy 2.44.8. hammer location add-subnet Associate a subnet 2.44.9. hammer location add-user Associate an user 2.44.10. hammer location create Create a location 2.44.11. hammer location delete Delete a location 2.44.12. hammer location delete-parameter Delete parameter for a location 2.44.13. hammer location info Show a location 2.44.14. hammer location list List all locations 2.44.15. hammer location remove-compute-resource Disassociate a compute resource 2.44.16. hammer location remove-domain Disassociate a domain 2.44.17. hammer location remove-hostgroup Disassociate a hostgroup 2.44.18. hammer location remove-medium Disassociate a medium 2.44.19. hammer location remove-organization Disassociate an organization 2.44.20. hammer location remove-provisioning-template Disassociate provisioning templates 2.44.21. hammer location remove-smart-proxy Disassociate a smart proxy 2.44.22. hammer location remove-subnet Disassociate a subnet 2.44.23. hammer location remove-user Disassociate an user 2.44.24. hammer location set-parameter Create or update parameter for a location 2.44.25. hammer location update Update a location 2.45. hammer mail-notification Manage mail notifications 2.45.1. hammer mail-notification info Show an email notification 2.45.2. hammer mail-notification list List of email notifications 2.46. hammer medium Manipulate installation media 2.46.1. hammer medium add-operatingsystem Associate an operating system 2.46.2. hammer medium create Create a medium 2.46.3. hammer medium delete Delete a medium 2.46.4. hammer medium info Show a medium 2.46.5. hammer medium list List all installation media 2.46.6. hammer medium remove-operatingsystem Disassociate an operating system 2.46.7. hammer medium update Update a medium 2.47. hammer model Manipulate hardware models 2.47.1. hammer model create Create a hardware model 2.47.2. hammer model delete Delete a hardware model 2.47.3. hammer model info Show a hardware model 2.47.4. hammer model list List all hardware models 2.47.5. hammer model update Update a hardware model 2.48. hammer module-stream View Module Streams 2.48.1. hammer module-stream info Show a module stream 2.48.2. hammer module-stream list List module streams 2.49. hammer organization Manipulate organizations 2.49.1. hammer organization add-compute-resource Associate a compute resource 2.49.2. hammer organization add-domain Associate a domain 2.49.3. hammer organization add-hostgroup Associate a hostgroup 2.49.4. hammer organization add-location Associate a location 2.49.5. hammer organization add-medium Associate a medium 2.49.6. hammer organization add-provisioning-template Associate provisioning templates 2.49.7. hammer organization add-smart-proxy Associate a smart proxy 2.49.8. hammer organization add-subnet Associate a subnet 2.49.9. hammer organization add-user Associate an user 2.49.10. hammer organization configure-cdn Update the CDN configuration 2.49.11. hammer organization create Create organization 2.49.12. hammer organization delete Delete an organization 2.49.13. hammer organization delete-parameter Delete parameter for an organization 2.49.14. hammer organization info Show organization 2.49.15. hammer organization list List all organizations 2.49.16. hammer organization remove-compute-resource Disassociate a compute resource 2.49.17. hammer organization remove-domain Disassociate a domain 2.49.18. hammer organization remove-hostgroup Disassociate a hostgroup 2.49.19. hammer organization remove-location Disassociate a location 2.49.20. hammer organization remove-medium Disassociate a medium 2.49.21. hammer organization remove-provisioning-template Disassociate provisioning templates 2.49.22. hammer organization remove-smart-proxy Disassociate a smart proxy 2.49.23. hammer organization remove-subnet Disassociate a subnet 2.49.24. hammer organization remove-user Disassociate an user 2.49.25. hammer organization set-parameter Create or update parameter for an organization 2.49.26. hammer organization update Update organization 2.50. hammer os Manipulate operating system 2.50.1. hammer os add-architecture Associate an architecture 2.50.2. hammer os add-provisioning-template Associate provisioning templates 2.50.3. hammer os add-ptable Associate a partition table 2.50.4. hammer os create Create an operating system 2.50.5. hammer os delete Delete an operating system 2.50.6. hammer os delete-default-template 2.50.7. hammer os delete-parameter Delete parameter for an operating system 2.50.8. hammer os info Show an operating system 2.50.9. hammer os list List all operating systems 2.50.10. hammer os remove-architecture Disassociate an architecture 2.50.11. hammer os remove-provisioning-template Disassociate provisioning templates 2.50.12. hammer os remove-ptable Disassociate a partition table 2.50.13. hammer os set-default-template 2.50.14. hammer os set-parameter Create or update parameter for an operating system 2.50.15. hammer os update Update an operating system 2.51. hammer package Manipulate packages 2.51.1. hammer package info Show a package 2.51.2. hammer package list List packages 2.52. hammer package-group Manipulate package groups 2.52.1. hammer package-group info Show a package group 2.52.2. hammer package-group list List package_groups 2.53. hammer partition-table Manipulate partition tables 2.53.1. hammer partition-table add-operatingsystem Associate an operating system 2.53.2. hammer partition-table create Create a partition table 2.53.3. hammer partition-table delete Delete a partition table 2.53.4. hammer partition-table dump View partition table content 2.53.5. hammer partition-table info Show a partition table 2.53.6. hammer partition-table list List all partition tables 2.53.7. hammer partition-table remove-operatingsystem Disassociate an operating system 2.53.8. hammer partition-table update Update a partition table 2.54. hammer ping Get the status of the server and/or it's subcomponents 2.54.1. hammer ping foreman Shows status of Satellite system and it's subcomponents 2.54.2. hammer ping katello Shows status of Katello system and it's subcomponents 2.55. hammer policy Manipulate policies 2.55.1. hammer policy create Create a Policy 2.55.2. hammer policy delete Delete a Policy 2.55.3. hammer policy hosts List all hosts 2.55.4. hammer policy info Show a Policy 2.55.5. hammer policy list List Policies 2.55.6. hammer policy update Update a Policy 2.56. hammer prebuild-bash-completion Prepare map of options and subcommands for Bash completion 2.57. hammer product Manipulate products 2.57.1. hammer product create Create a product 2.57.2. hammer product delete Destroy a product 2.57.3. hammer product info Show a product 2.57.4. hammer product list List products 2.57.5. hammer product remove-sync-plan Delete assignment sync plan and product 2.57.6. hammer product set-sync-plan Assign sync plan to product 2.57.7. hammer product synchronize Sync all repositories for a product 2.57.8. hammer product update Updates a product 2.57.9. hammer product update-proxy Updates an HTTP Proxy for a product 2.58. hammer proxy Manipulate smart proxies 2.58.1. hammer proxy content Manage the capsule content 2.58.1.1. hammer proxy content add-lifecycle-environment Add lifecycle environments to the capsule 2.58.1.2. hammer proxy content available-lifecycle-environments List the lifecycle environments not attached to the capsule 2.58.1.3. hammer proxy content cancel-synchronization Cancel running capsule synchronization 2.58.1.4. hammer proxy content info Get current capsule synchronization status 2.58.1.5. hammer proxy content lifecycle-environments List the lifecycle environments attached to the capsule 2.58.1.6. hammer proxy content remove-lifecycle-environment Remove lifecycle environments from the capsule 2.58.1.7. hammer proxy content synchronization-status Get current capsule synchronization status 2.58.1.8. hammer proxy content synchronize Synchronize the content to the capsule 2.58.2. hammer proxy create Create a capsule 2.58.3. hammer proxy delete Delete a capsule 2.58.4. hammer proxy info Show a capsule 2.58.5. hammer proxy list List all capsules 2.58.6. hammer proxy refresh-features Refresh capsule features 2.58.7. hammer proxy update Update a capsule 2.59. hammer realm Manipulate realms 2.59.1. hammer realm create Create a realm 2.59.2. hammer realm delete Delete a realm 2.59.3. hammer realm info Show a realm 2.59.4. hammer realm list List of realms 2.59.5. hammer realm update Update a realm 2.60. hammer recurring-logic Recurring logic related actions 2.60.1. hammer recurring-logic cancel Cancel recurring logic 2.60.2. hammer recurring-logic delete Delete all recuring logics filtered by the arguments 2.60.3. hammer recurring-logic info Show recurring logic details 2.60.4. hammer recurring-logic list List recurring logics 2.61. hammer remote-execution-feature Manage remote execution features 2.61.1. hammer remote-execution-feature info Show remote execution feature 2.61.2. hammer remote-execution-feature list List remote execution features 2.61.3. hammer remote-execution-feature update Update a job template 2.62. hammer report Browse and read reports 2.62.1. hammer report delete Delete a report 2.62.2. hammer report info Show a report 2.62.3. hammer report list List all reports 2.63. hammer report-template Manipulate report templates 2.63.1. hammer report-template clone Clone a template 2.63.2. hammer report-template create Create a report template 2.63.3. hammer report-template delete Delete a report template 2.63.4. hammer report-template dump View report content 2.63.5. hammer report-template generate Generate report 2.63.6. hammer report-template import Import a report template 2.63.7. hammer report-template info Show a report template 2.63.8. hammer report-template list List all report templates 2.63.9. hammer report-template report-data Downloads a generated report 2.63.10. hammer report-template schedule Schedule generating of a report 2.63.11. hammer report-template update Update a report template 2.64. hammer repository Manipulate repositories 2.64.1. hammer repository create Create a custom repository 2.64.2. hammer repository delete Destroy a custom repository 2.64.3. hammer repository info Show a repository 2.64.4. hammer repository list List of enabled repositories 2.64.5. hammer repository reclaim-space Reclaim space from an On Demand repository 2.64.6. hammer repository remove-content Remove content from a repository 2.64.7. hammer repository synchronize Sync a repository 2.64.8. hammer repository update Update a repository 2.64.9. hammer repository upload-content Upload content into the repository 2.65. hammer repository-set Manipulate repository sets on the server 2.65.1. hammer repository-set available-repositories Get list of available repositories for the repository set 2.65.2. hammer repository-set disable Disable a repository from the set 2.65.3. hammer repository-set enable Enable a repository from the set 2.65.4. hammer repository-set info Get info about a repository set 2.65.5. hammer repository-set list List repository sets. 2.66. hammer role Manage user roles 2.66.1. hammer role clone Clone a role 2.66.2. hammer role create Create a role 2.66.3. hammer role delete Delete a role 2.66.4. hammer role filters List all filters 2.66.5. hammer role info Show a role 2.66.6. hammer role list List all roles 2.66.7. hammer role update Update a role 2.67. hammer scap-content Manipulate SCAP contents 2.67.1. hammer scap-content bulk-upload Upload scap contents in bulk 2.67.2. hammer scap-content create Create SCAP content 2.67.3. hammer scap-content delete Deletes an SCAP content 2.67.4. hammer scap-content download Download an SCAP content as XML 2.67.5. hammer scap-content info Show an SCAP content 2.67.6. hammer scap-content list List SCAP contents 2.67.7. hammer scap-content update Update an SCAP content 2.68. hammer scap-content-profile Manipulate Scap Content Profiles 2.68.1. hammer scap-content-profile list List SCAP content profiles 2.69. hammer settings Change server settings 2.69.1. hammer settings info Show a setting 2.69.2. hammer settings list List all settings 2.69.3. hammer settings set Update a setting 2.70. hammer shell Interactive shell 2.71. hammer simple-content-access Simple content access commands 2.71.1. hammer simple-content-access disable Disable simple content access for a manifest 2.71.2. hammer simple-content-access enable Enable simple content access for a manifest 2.72. hammer srpm Manipulate source RPMs 2.72.1. hammer srpm info Show SRPM details 2.72.2. hammer srpm list List srpms 2.73. hammer status Get the complete status of the server and/or it's subcomponents 2.73.1. hammer status foreman Shows status and version information of Satellite system and it's subcomponents 2.73.2. hammer status katello Shows version information 2.74. hammer subnet Manipulate subnets 2.74.1. hammer subnet create Create a subnet 2.74.2. hammer subnet delete Delete a subnet 2.74.3. hammer subnet delete-parameter Delete parameter for a subnet 2.74.4. hammer subnet info Show a subnet 2.74.5. hammer subnet list List of subnets 2.74.6. hammer subnet set-parameter Create or update parameter for a subnet 2.74.7. hammer subnet update Update a subnet 2.75. hammer subscription Manipulate subscriptions 2.75.1. hammer subscription delete-manifest Delete manifest from Red Hat provider 2.75.2. hammer subscription list List organization subscriptions 2.75.3. hammer subscription manifest-history obtain manifest history for subscriptions 2.75.4. hammer subscription refresh-manifest Refresh previously imported manifest for Red Hat provider 2.75.5. hammer subscription upload Upload a subscription manifest 2.76. hammer sync-plan Manipulate sync plans 2.76.1. hammer sync-plan create Create a sync plan 2.76.2. hammer sync-plan delete Destroy a sync plan 2.76.3. hammer sync-plan info Show a sync plan 2.76.4. hammer sync-plan list List sync plans 2.76.5. hammer sync-plan update Update a sync plan 2.77. hammer tailoring-file Manipulate Tailoring files 2.77.1. hammer tailoring-file create Create a Tailoring file 2.77.2. hammer tailoring-file delete Deletes a Tailoring file 2.77.3. hammer tailoring-file download Download a Tailoring file as XML 2.77.4. hammer tailoring-file info Show a Tailoring file 2.77.5. hammer tailoring-file list List Tailoring files 2.77.6. hammer tailoring-file update Update a Tailoring file 2.78. hammer task Tasks related actions. 2.78.1. hammer task info Show task details 2.78.2. hammer task list List tasks 2.78.3. hammer task progress Show the progress of the task 2.78.4. hammer task resume Resume all tasks paused in error state 2.79. hammer template Manipulate provisioning templates 2.79.1. hammer template add-operatingsystem Associate an operating system 2.79.2. hammer template build-pxe-default Update the default PXE menu on all configured TFTP servers 2.79.3. hammer template clone Clone a provision template 2.79.4. hammer template combination Manage template combinations 2.79.4.1. hammer template combination create Add a template combination 2.79.4.2. hammer template combination delete Delete a template combination 2.79.4.3. hammer template combination info Show template combination 2.79.4.4. hammer template combination list List template combination 2.79.4.5. hammer template combination update Update template combination 2.79.5. hammer template create Create a provisioning template 2.79.6. hammer template delete Delete a provisioning template 2.79.7. hammer template dump View provisioning template content 2.79.8. hammer template info Show provisioning template details 2.79.9. hammer template kinds List available provisioning template kinds 2.79.10. hammer template list List provisioning templates 2.79.11. hammer template remove-operatingsystem Disassociate an operating system 2.79.12. hammer template update Update a provisioning template 2.80. hammer template-input Manage template inputs 2.80.1. hammer template-input create Create a template input 2.80.2. hammer template-input delete Delete a template input 2.80.3. hammer template-input info Show template input details 2.80.4. hammer template-input list List template inputs 2.80.5. hammer template-input update Update a template input 2.81. hammer user Manipulate users 2.81.1. hammer user access-token Managing personal access tokens 2.81.1.1. hammer user access-token create Create a Personal Access Token for a user 2.81.1.2. hammer user access-token info Show a Personal Access Token for a user 2.81.1.3. hammer user access-token list List all Personal Access Tokens for a user 2.81.1.4. hammer user access-token revoke Revoke a Personal Access Token for a user 2.81.2. hammer user add-role Assign a user role 2.81.3. hammer user create Create a user 2.81.4. hammer user delete Delete a user 2.81.5. hammer user info Show a user 2.81.6. hammer user list List all users 2.81.7. hammer user mail-notification Managing personal mail notifications 2.81.7.1. hammer user mail-notification add Add an email notification for a user 2.81.7.2. hammer user mail-notification list List all email notifications for a user 2.81.7.3. hammer user mail-notification remove Remove an email notification for a user 2.81.7.4. hammer user mail-notification update Update an email notification for a user 2.81.8. hammer user remove-role Remove a user role 2.81.9. hammer user ssh-keys Managing User SSH Keys. 2.81.9.1. hammer user ssh-keys add Add an SSH key for a user 2.81.9.2. hammer user ssh-keys delete Delete an SSH key for a user 2.81.9.3. hammer user ssh-keys info Show an SSH key from a user 2.81.9.4. hammer user ssh-keys list List all SSH keys for a user 2.81.10. hammer user update Update a user 2.82. hammer user-group Manage user groups 2.82.1. hammer user-group add-role Assign a user role 2.82.2. hammer user-group add-user Associate an user 2.82.3. hammer user-group add-user-group Associate an user group 2.82.4. hammer user-group create Create a user group 2.82.5. hammer user-group delete Delete a user group 2.82.6. hammer user-group external View and manage user group's external user groups 2.82.6.1. hammer user-group external create Create an external user group linked to a user group 2.82.6.2. hammer user-group external delete Delete an external user group 2.82.6.3. hammer user-group external info Show an external user group for user group 2.82.6.4. hammer user-group external list List all external user groups for user group 2.82.6.5. hammer user-group external refresh Refresh external user group 2.82.6.6. hammer user-group external update Update external user group 2.82.7. hammer user-group info Show a user group 2.82.8. hammer user-group list List all user groups 2.82.9. hammer user-group remove-role Remove a user role 2.82.10. hammer user-group remove-user Disassociate an user 2.82.11. hammer user-group remove-user-group Disassociate an user group 2.82.12. hammer user-group update Update a user group 2.83. hammer virt-who-config Manage Virt Who configurations 2.83.1. hammer virt-who-config create Create a virt-who configuration 2.83.2. hammer virt-who-config delete Delete a virt-who configuration 2.83.3. hammer virt-who-config deploy Download and execute script for the specified virt-who configuration 2.83.4. hammer virt-who-config fetch Renders a deploy script for the specified virt-who configuration 2.83.5. hammer virt-who-config info Show a virt-who configuration 2.83.6. hammer virt-who-config list List of virt-who configurations 2.83.7. hammer virt-who-config update Update a virt-who configuration 2.84. hammer webhook Manage webhooks 2.84.1. hammer webhook create Create a Webhook 2.84.2. hammer webhook delete Delete a Webhook 2.84.3. hammer webhook info Show Webhook details 2.84.4. hammer webhook list List Webhooks 2.84.5. hammer webhook update Update a Webhook 2.85. hammer webhook-template Manipulate webhook templates 2.85.1. hammer webhook-template clone Clone a template 2.85.2. hammer webhook-template create Create a webhook template 2.85.3. hammer webhook-template delete Delete a webhook template 2.85.4. hammer webhook-template dump View webhook template content 2.85.5. hammer webhook-template import Import a webhook template 2.85.6. hammer webhook-template info Show webhook template details 2.85.7. hammer webhook-template list List webhook templates 2.85.8. hammer webhook-template update Update a webhook template
[ "Usage: hammer [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: activation-key Manipulate activation keys admin Administrative server-side tasks ansible Manage foreman ansible architecture Manipulate architectures arf-report Manipulate compliance reports audit Search audit trails. auth Foreman connection login/logout auth-source Manipulate auth sources bookmark Manage bookmarks bootdisk Download boot disks capsule Manipulate capsule compute-profile Manipulate compute profiles compute-resource Manipulate compute resources config-report Browse and read reports content-credentials Manipulate content credentials on the server content-export Prepare content for export to a disconnected Katello content-import Import content from an upstream archive. content-units Manipulate content units content-view Manipulate content views deb-package Manipulate deb packages defaults Defaults management discovery Manipulate discovered hosts. discovery-rule Manipulate discovered rules. docker Manipulate docker content domain Manipulate domains erratum Manipulate errata export-templates Export templates to a git repo or a directory on the server fact Search facts file Manipulate files filter Manage permission filters foreign-input-set Manage foreign input sets full-help Print help for all hammer commands global-parameter Manipulate global parameters host Manipulate hosts host-collection Manipulate host collections host-registration Host Registration hostgroup Manipulate hostgroups http-proxy Manipulate http proxies import-templates Import templates from a git repo or a directory on the server job-invocation Manage job invocations job-template Manage job templates lifecycle-environment Manipulate lifecycle_environments on the server location Manipulate locations mail-notification Manage mail notifications medium Manipulate installation media model Manipulate hardware models module-stream View Module Streams organization Manipulate organizations os Manipulate operating system package Manipulate packages package-group Manipulate package groups partition-table Manipulate partition tables ping Get the status of the server and/or it's subcomponents policy Manipulate policies prebuild-bash-completion Prepare map of options and subcommands for Bash completion product Manipulate products proxy Manipulate smart proxies realm Manipulate realms recurring-logic Recurring logic related actions remote-execution-feature Manage remote execution features report Browse and read reports report-template Manipulate report templates repository Manipulate repositories repository-set Manipulate repository sets on the server role Manage user roles scap-content Manipulate SCAP contents scap-content-profile Manipulate Scap Content Profiles settings Change server settings shell Interactive shell simple-content-access Simple content access commands srpm Manipulate source RPMs status Get the complete status of the server and/or it's subcomponents subnet Manipulate subnets subscription Manipulate subscriptions sync-plan Manipulate sync plans tailoring-file Manipulate Tailoring files task Tasks related actions. template Manipulate provisioning templates template-input Manage template inputs user Manipulate users user-group Manage user groups virt-who-config Manage Virt Who configurations webhook Manage webhooks webhook-template Manipulate webhook templates Options: --[no-]use-defaults Enable/disable stored defaults. Enabled by default --autocomplete VALUE Get list of possible endings --csv Output as CSV (same as --output=csv) --csv-separator VALUE Character to separate the values --fetch-ca-cert VALUE Fetch CA certificate from server and exit --interactive BOOLEAN Explicitly turn interactive mode on/off --no-headers Hide headers from output --output ENUM Set output format Possible value(s): 'base', 'table', 'silent', 'csv', 'yaml', 'json' --output-file VALUE Path to custom output file --show-ids Show ids of associated resources --ssl-ca-file VALUE Configure the file containing the CA certificates --ssl-ca-path VALUE Configure the directory containing the CA certificates --ssl-client-cert VALUE Configure the client's public certificate --ssl-client-key VALUE Configure the client's private key --ssl-with-basic-auth Use standard authentication in addition to client certificate authentication --verify-ssl BOOLEAN Configure SSL verification of remote system --version Show version -c, --config VALUE Path to custom config file -d, --debug Show debugging output -h, --help Print help -p, --password VALUE Password to access the remote system -q, --quiet Completely silent -r, --reload-cache Force reload of Apipie cache -s, --server VALUE Remote system address -u, --username VALUE Username to access the remote system -v, --[no-]verbose Be verbose (or not). True by default Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-host-collection Associate a resource add-subscription Add subscription content-override Override product content defaults copy Copy an activation key create Create an activation key delete, destroy Destroy an activation key host-collections List associated host collections info, show Show an activation key list, index List activation keys product-content List associated products remove-host-collection Disassociate a resource remove-subscription Remove subscription subscriptions List associated subscriptions update Update an activation key Options: -h, --help Print help", "Usage: hammer activation-key add-host-collection [OPTIONS] Options: --host-collection VALUE Host collection name to search by --host-collection-id NUMBER Id of the host collection --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key add-subscription [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --quantity NUMBER Quantity of this subscription to add --subscription VALUE Subscription name to search by --subscription-id NUMBER Subscription identifier --subscriptions SCHEMA Array of subscriptions to add -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --subscriptions \"id=<string>\\,quantity=<numeric>, ... \"", "Usage: hammer activation-key content-override [OPTIONS] Options: --content-label VALUE Label of the content --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --override-name VALUE Override parameter key or name. To enable or disable a repo select 'enabled'. Default value: enabled Default: \"enabled\" --remove Remove a content override --value VALUE Override value. Note for repo enablement you can use a boolean value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key copy [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --new-name VALUE Name of new activation key --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key create [OPTIONS] Options: --auto-attach BOOLEAN Auto attach subscriptions upon registration --content-view VALUE Content view name to search by --content-view-id NUMBER Content view id --description VALUE Description --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment id --max-hosts NUMBER Maximum number of registered content hosts --name VALUE Name --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --release-version VALUE Content release version --service-level VALUE Service level --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key <delete|destroy> [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key host-collections [OPTIONS] Options: --available-for VALUE Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported. --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host-id NUMBER Filter products by host id --id VALUE ID of activation key --name VALUE Name of activation key --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --sort-by VALUE Field to sort the results on --sort-order VALUE How to order the sorted results (e.g. ASC for ascending) -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: ------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------------|-----|---------|----- Name | x | x | x Id | x | x | x Description | x | x | Host limit | x | x | Auto attach | x | x | Release version | x | x | Lifecycle environment | x | x | Content view | x | x | Host collections/id | x | x | Host collections/name | x | x | System purpose/service level | x | x | System purpose/purpose usage | x | x | System purpose/purpose role | x | x | System purpose/purpose addons | x | x | ------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --name VALUE Activation key name to filter by --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Name | x | x | x Host limit | x | x | Lifecycle environment | x | x | Content view | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: addon string content_view string content_view_id integer description text environment string name string organization_id integer role string subscription_id string subscription_name string usage string", "Usage: hammer activation-key product-content [OPTIONS] Options: --content-access-mode-all BOOLEAN Get all content available, not just that provided by subscriptions --content-access-mode-env BOOLEAN Limit content to just that available in the activation key's content view version --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Type | x | x | Url | x | x | Gpg key | x | x | Label | x | x | Default enabled? | x | x | Override | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key remove-host-collection [OPTIONS] Options: --host-collection VALUE Host collection name to search by --host-collection-id NUMBER Id of the host collection --id VALUE ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key remove-subscription [OPTIONS] Options: --id NUMBER ID of the activation key --name VALUE Activation key name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --subscription-id VALUE ID of subscription -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key subscriptions [OPTIONS] Options: --activation-key VALUE Activation key name to search by --activation-key-id VALUE Activation key ID --available-for VALUE Object to show subscriptions available for, either 'host' or 'activation_key' --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id VALUE Id of a host --id VALUE ID of the activation key --match-host BOOLEAN Ignore subscriptions that are unavailable to the specified host --match-installed BOOLEAN Return subscriptions that match installed products of the specified host --name VALUE Activation key name to search by --no-overlap BOOLEAN Return subscriptions which do not overlap with a currently-attached subscription --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: -----------|-----|-------- FIELDS | ALL | DEFAULT -----------|-----|-------- Id | x | x Name | x | x Attached | x | x Quantity | x | x Start date | x | x End date | x | x Support | x | x Contract | x | x Account | x | x -----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer activation-key update [OPTIONS] Options: --auto-attach BOOLEAN Auto attach subscriptions upon registration --content-view VALUE Content view name to search by --content-view-id NUMBER Content view id --description VALUE Description --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER ID of the activation key --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment id --max-hosts NUMBER Maximum number of registered content hosts --name VALUE Name --new-name VALUE Name --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --release-version VALUE Content release version --service-level VALUE Service level --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer admin [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: logging Logging verbosity level setup Options: -h, --help Print help", "Usage: hammer admin logging [OPTIONS] Options: --no-backup Skip configuration backups creation. --prefix VALUE Operate on prefixed environment (e.g. chroot). -a, --all Apply to all components. -c, --components LIST Components to apply, use --list to get them. -d, --level-debug Increase verbosity level to debug. -h, --help Print help -l, --list List available components. -n, --dry-run Do not apply specified changes. -p, --level-production Decrease verbosity level to standard. Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: roles Manage ansible roles variables Manage ansible variables Options: -h, --help Print help", "Usage: hammer ansible roles [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Deletes Ansible role fetch Fetch Ansible roles available to be synced import DEPRECATED: Import Ansible roles info, show Show role list, index List Ansible roles obsolete DEPRECATED: Obsolete Ansible roles play-hostgroups Runs all Ansible roles on hostgroups play-hosts Runs all Ansible roles on hosts sync Sync Ansible roles Options: -h, --help Print help", "Usage: hammer ansible roles <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles fetch [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to fetch from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles import [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from --role-names LIST Ansible role names to be imported -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: host string host_id integer hostgroup string hostgroup_id integer id integer name string updated_at datetime", "Usage: hammer ansible roles obsolete [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles play-hostgroups [OPTIONS] Options: --hostgroup-ids LIST IDs of hostgroups to play roles on --hostgroup-titles LIST --hostgroups LIST --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles play-hosts [OPTIONS] Options: --host-ids LIST IDs of hosts to play roles on --hosts LIST --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible roles sync [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to sync from --role-names LIST Ansible role names to be synced -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-matcher Create an override value for a specific ansible variable create Create Ansible variable delete, destroy Deletes Ansible variable import DEPRECATED: Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles info, show Show variable list, index List Ansible variables obsolete DEPRECATED: Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles remove-matcher Destroy an override value update Updates Ansible variable Options: -h, --help Print help", "Usage: hammer ansible variables add-matcher [OPTIONS] Options: --ansible-variable VALUE Name to search by --ansible-variable-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --match VALUE Override match --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --value VALUE Override value, required if omit is false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables create [OPTIONS] Options: --ansible-role VALUE Name to search by --ansible-role-id NUMBER Role ID --avoid-duplicates BOOLEAN Remove duplicate values (only array type) --default-value VALUE Default value of variable --description VALUE Description of variable --hidden-value BOOLEAN When enabled the parameter is hidden in the UI --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --merge-default BOOLEAN Include default value when merging all matching values --merge-overrides BOOLEAN Merge all matching values (only array/hash type) --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --override BOOLEAN Whether to override variable or not --override-value-order VALUE The order in which values are resolved --validator-rule VALUE Used to enforce certain values for the parameter values --validator-type ENUM Types of validation values Possible value(s): 'regexp', 'list' --variable VALUE Name of variable --variable-type ENUM Types of variable values Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables import [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------------------------|-----|-------- FIELDS | ALL | DEFAULT ------------------------------------|-----|-------- Id | x | x Variable | x | x Default value | x | x Type | x | x Role | x | x Role id | x | x Description | x | x Hidden value? | x | x Validator/type | x | x Validator/rule | x | x Override values/override | x | x Override values/merge overrides | x | x Override values/merge default value | x | x Override values/avoid duplicates | x | x Override values/order | x | x Override values/values/id | x | x Override values/values/match | x | x Override values/values/value | x | x Created at | x | x Updated at | x | x ------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------|-----|-------- FIELDS | ALL | DEFAULT --------------|-----|-------- Id | x | x Variable | x | x Default value | x | x Type | x | x Role | x | x Role id | x | x --------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: ansible_role string avoid_duplicates Values: true, false imported Values: true, false key string merge_default Values: true, false merge_overrides Values: true, false name string override Values: true, false parameter string", "Usage: hammer ansible variables obsolete [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --proxy-id VALUE Capsule to import from -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables remove-matcher [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ansible variables update [OPTIONS] Options: --ansible-role VALUE Name to search by --ansible-role-id NUMBER Role ID --avoid-duplicates BOOLEAN Remove duplicate values (only array type) --default-value VALUE Default value of variable --description VALUE Description of variable --hidden-value BOOLEAN When enabled the parameter is hidden in the UI --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --merge-default BOOLEAN Include default value when merging all matching values --merge-overrides BOOLEAN Merge all matching values (only array/hash type) --name VALUE Name to search by --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --override BOOLEAN Whether to override variable or not --override-value-order LIST The order in which values are resolved --validator-rule VALUE Used to enforce certain values for the parameter values --validator-type ENUM Types of validation values Possible value(s): 'regexp', 'list' --variable VALUE Name of variable --variable-type ENUM Types of variable values Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create an architecture delete, destroy Delete an architecture info, show Show an architecture list, index List all architectures remove-operatingsystem Disassociate an operating system update Update an architecture Options: -h, --help Print help", "Usage: hammer architecture add-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Architecture name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --operatingsystem-ids LIST Operating system IDs --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Architecture name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Architecture name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Name | x | x | x Operating systems/ | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string", "Usage: hammer architecture remove-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Architecture name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer architecture update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --operatingsystem-ids LIST Operating system IDs --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer arf-report [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Delete an ARF Report download Download bzipped ARF report download-html Download ARF report in HTML info, show Show an ARF report list, index List ARF reports Options: -h, --help Print help", "Usage: hammer arf-report <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer arf-report download [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer arf-report download-html [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer arf-report <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Reported at | x | x | Host name | x | x | x Openscap proxy name | x | x | Policy name | x | x | Passed | x | x | Failed | x | x | Othered | x | x | Host id | x | x | Openscap proxy id | x | x | Policy id | x | x | Locations/ | x | x | Organizations/ | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer arf-report <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Reported at | x | x | Host name | x | x | x Openscap proxy name | x | x | Policy name | x | x | Passed | x | x | Failed | x | x | Othered | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: compliance_policy string compliance_status Values: compliant, incompliant, inconclusive comply_with string eventful Values: true, false host string host_collection string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string inconclusive_with string last_for Values: host, policy last_report datetime lifecycle_environment string location string location_id integer log text not_comply_with string openscap_proxy string organization string organization_id integer origin string policy string reported datetime resource text xccdf_rule_failed string xccdf_rule_name text xccdf_rule_othered string xccdf_rule_passed string", "Usage: hammer audit [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show an audit list, index List all audits Options: -h, --help Print help", "Usage: hammer audit <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------|-----|---------|----- Id | x | x | x At | x | x | Ip | x | x | User | x | x | Action | x | x | Audit type | x | x | Audit record | x | x | Request uuid | x | x | Audited changes/attribute | x | x | Audited changes/value | x | x | Audited changes/old | x | x | Audited changes/new | x | x | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer audit <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x At | x | x | Ip | x | x | User | x | x | Action | x | x | Audit type | x | x | Audit record | x | x | Request uuid | x | | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: action string auditable_id integer authored_by_user string authored_by_user.id integer changes text comment string host string hostgroup string hostgroup_title string id integer interface_fqdn string interface_ip string interface_mac string location string location_id integer organization string organization_id integer os string os_title string parameter string partition_table string provisioning_template string puppetclass remote_address string request_uuid string setting string time datetime type Values: role, ptable, provisioning_template, user, filter, architecture, bookmark, compute_profile, domain, hostgroup, http_proxy, image, key_pair, medium, model, personal_access_token, report_template, realm, smart_proxy, ssh_key, subnet, usergroup, job_template, remote_execution_feature, job_invocation, ansible_role, discovery_rule, katello/activation_key, katello/content_view, katello/content_credential, katello/host_collection, katello/kt_environment, katello/product, katello/sync_plan, foreman_virt_who_configure/config, foreman_openscap/policy, foreman_openscap/scap_content, foreman_openscap/tailoring_file, foreman_openscap/oval_content, foreman_openscap/oval_policy, compute_attribute, lookup_value, katello/repository, katello/host/content_facet, katello/hostgroup/content_facet, katello/host/subscription_facet, katello/root_repository, auth_source, compute_resource, host, interface, location, organization, os, override_value, parameter, partition_table, setting, smart_class_parameter user string username string", "Usage: hammer auth [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: login Set credentials logout Wipe your credentials status Information about current connections Options: -h, --help Print help", "Usage: hammer auth login [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: basic Provide username and password oauth Supports for both with/without 2fa Options: -h, --help Print help", "Usage: hammer auth login basic [OPTIONS] Options: -h, --help Print help -p, --password VALUE Password to access the remote system -u, --username VALUE Username to access the remote system Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth login oauth [OPTIONS] Options: -a, --oidc-authorization-endpoint VALUE Openidc provider URL which issues authentication code (two factor only) -c, --oidc-client-id VALUE Client id used in the Openidc provider -f, --two-factor Authenticate with two factor -h, --help Print help -p, --password VALUE Password to access the remote system -r, --oidc-redirect-uri VALUE Redirect URI for the authentication code grant flow -t, --oidc-token-endpoint VALUE Openidc provider URL which issues access token -u, --username VALUE Username to access the remote system Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth logout [OPTIONS] Options: -h, --help Print help", "Usage: hammer auth status [OPTIONS] Options: -h, --help Print help", "Usage: hammer auth-source [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: external Manage external auth sources ldap Manage LDAP auth sources list, index List all auth sources Options: -h, --help Print help", "Usage: hammer auth-source external [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show an external authentication source list, index List external authentication sources update Update organization and location for Auth Source Options: -h, --help Print help", "Usage: hammer auth-source external <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Locations/ | x | x | Organizations/ | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source external <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer", "Usage: hammer auth-source external update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source ldap [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an LDAP authentication source delete, destroy Delete an LDAP authentication source info, show Show an LDAP authentication source list, index List all LDAP authentication sources update Update an LDAP authentication source Options: -h, --help Print help", "Usage: hammer auth-source ldap create [OPTIONS] Options: --account VALUE --account-password VALUE Required if onthefly_register is true --attr-firstname VALUE Required if onthefly_register is true --attr-lastname VALUE Required if onthefly_register is true --attr-login VALUE Required if onthefly_register is true --attr-mail VALUE Required if onthefly_register is true --attr-photo VALUE --base-dn VALUE --groups-base VALUE Groups base DN --host VALUE The hostname of the LDAP server --ldap-filter VALUE LDAP filter --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --onthefly-register BOOLEAN --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --port NUMBER Defaults to 389 --server-type ENUM Type of the LDAP server Possible value(s): 'free_ipa', 'active_directory', 'posix' --tls BOOLEAN --use-netgroups BOOLEAN Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa --usergroup-sync BOOLEAN Sync external user groups on login -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source ldap <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source ldap <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------------------------------------|-----|-------- FIELDS | ALL | DEFAULT -------------------------------------------|-----|-------- Server/id | x | x Server/name | x | x Server/server | x | x Server/ldaps | x | x Server/port | x | x Server/server type | x | x Account/account username | x | x Account/base dn | x | x Account/groups base dn | x | x Account/use netgroups | x | x Account/ldap filter | x | x Account/automatically create accounts? | x | x Account/usergroup sync | x | x Attribute mappings/login name attribute | x | x Attribute mappings/first name attribute | x | x Attribute mappings/last name attribute | x | x Attribute mappings/email address attribute | x | x Attribute mappings/photo attribute | x | x Locations/ | x | x Organizations/ | x | x -------------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source ldap <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Server | x | x | Port | x | x | Ldaps? | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer", "Usage: hammer auth-source ldap update [OPTIONS] Options: --account VALUE --account-password VALUE Required if onthefly_register is true --attr-firstname VALUE Required if onthefly_register is true --attr-lastname VALUE Required if onthefly_register is true --attr-login VALUE Required if onthefly_register is true --attr-mail VALUE Required if onthefly_register is true --attr-photo VALUE --base-dn VALUE --groups-base VALUE Groups base DN --host VALUE The hostname of the LDAP server --id VALUE --ldap-filter VALUE LDAP filter --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --onthefly-register BOOLEAN --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --port NUMBER Defaults to 389 --server-type ENUM Type of the LDAP server Possible value(s): 'free_ipa', 'active_directory', 'posix' --tls BOOLEAN --use-netgroups BOOLEAN Use NIS netgroups instead of posix groups, applicable only when server_type is posix or free_ipa --usergroup-sync BOOLEAN Sync external user groups on login -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer auth-source <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Name | x | x | x Type of auth source | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer", "Usage: hammer bookmark [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a bookmark delete, destroy Delete a bookmark info, show Show a bookmark list, index List all bookmarks update Update a bookmark Options: -h, --help Print help", "Usage: hammer bookmark create [OPTIONS] Options: --controller VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --public BOOLEAN --query VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bookmark <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bookmark <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Controller | x | x | Search query | x | x | Public | x | x | Owner id | x | x | Owner type | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bookmark <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Controller | x | x | Search query | x | x | Public | x | x | Owner id | x | x | Owner type | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: controller string name string", "Usage: hammer bookmark update [OPTIONS] Options: --controller VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --public BOOLEAN --query VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bootdisk [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: generic Download generic image host Download host image subnet Download subnet generic image Options: -h, --help Print help", "Usage: hammer bootdisk generic [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bootdisk host [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --full BOOLEAN True for full, false for basic reusable image --host VALUE Host name --host-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer bootdisk subnet [OPTIONS] Options: --file VALUE File or device to write image to --force Force writing to existing destination (device etc.) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --subnet VALUE Subnet name --subnet-id VALUE --sudo Use sudo to write to device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: content Manage the capsule content create Create a capsule delete, destroy Delete a capsule info, show Show a capsule list, index List all capsules refresh-features Refresh capsule features update Update a capsule Options: -h, --help Print help", "Usage: hammer capsule content [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-lifecycle-environment Add lifecycle environments to the capsule available-lifecycle-environments List the lifecycle environments not attached to the capsule cancel-synchronization Cancel running capsule synchronization info Get current capsule synchronization status lifecycle-environments List the lifecycle environments attached to the capsule remove-lifecycle-environment Remove lifecycle environments from the capsule synchronization-status Get current capsule synchronization status synchronize Synchronize the content to the capsule Options: -h, --help Print help", "Usage: hammer capsule content add-lifecycle-environment [OPTIONS] Options: --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content available-lifecycle-environments [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content cancel-synchronization [OPTIONS] Options: --id NUMBER Id of the capsule --name VALUE Name to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------------------------------------------------------------|-----|-------- FIELDS | ALL | DEFAULT -------------------------------------------------------------------|-----|-------- Lifecycle environments/name | x | x Lifecycle environments/organization | x | x Lifecycle environments/content views/name | x | x Lifecycle environments/content views/composite | x | x Lifecycle environments/content views/last published | x | x Lifecycle environments/content views/content/hosts | x | x Lifecycle environments/content views/content/products | x | x Lifecycle environments/content views/content/yum repos | x | x Lifecycle environments/content views/content/container image repos | x | x Lifecycle environments/content views/content/packages | x | x Lifecycle environments/content views/content/package groups | x | x Lifecycle environments/content views/content/errata | x | x -------------------------------------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content lifecycle-environments [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content remove-lifecycle-environment [OPTIONS] Options: --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content synchronization-status [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: --------------------------------------|-----|-------- FIELDS | ALL | DEFAULT --------------------------------------|-----|-------- Last sync | x | x Status | x | x Currently running sync tasks/task id | x | x Currently running sync tasks/progress | x | x Last failure/task id | x | x Last failure/messages | x | x --------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule content synchronize [OPTIONS] Options: --async Do not wait for the task --content-view VALUE Content view name to search by --content-view-id NUMBER Id of the content view to limit the synchronization on --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the environment to limit the synchronization on --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID --repository VALUE Repository name to search by --repository-id NUMBER Id of the repository to limit the synchronization on --skip-metadata-check BOOLEAN Skip metadata check on each repository on the capsule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule create [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --include-status BOOLEAN Flag to indicate whether to include status or not --include-version BOOLEAN Flag to indicate whether to include version or not --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | Version | x | x | Host_count | x | x | Features/name | x | x | Features/version | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --include-status BOOLEAN Flag to indicate whether to include status or not --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: feature string location string location_id integer name string organization string organization_id integer url string", "Usage: hammer capsule refresh-features [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer capsule update [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a compute profile delete, destroy Delete a compute profile info, show Show a compute profile list, index List of compute profiles update Update a compute profile values Create update and delete Compute profile values Options: -h, --help Print help", "Usage: hammer compute-profile create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute profile name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute profile name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | Compute attributes/id | x | x | Compute attributes/name | x | x | Compute attributes/compute resource | x | x | Compute attributes/vm attributes | x | x | ------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string", "Usage: hammer compute-profile update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile values [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-interface Add interface for Compute Profile add-volume Add volume for Compute Profile create Create compute profile set of values remove-interface Remove compute profile interface remove-volume Remove compute profile volume update Update compute profile values update-interface Update compute profile interface update-volume Update compute profile volume Options: -h, --help Print help", "Usage: hammer compute-profile values add-interface [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --interface: GCE: --interface: Libvirt: --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default OpenStack: --interface: oVirt: --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile Rackspace: --interface: VMware: --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware AzureRM: --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false)", "Usage: hammer compute-profile values add-volume [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --volume: GCE: --volume: size_gb Volume size in GB, integer value Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 OpenStack: --volume: oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi Rackspace: --volume: VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)", "Usage: hammer compute-profile values create [OPTIONS] Options: --compute-attributes KEY_VALUE_LIST Compute resource attributes --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values Can be specified multiple times. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --volume: --interface: --compute-attributes: availability_zone flavor_id groups security_group_ids managed_ip GCE: --volume: size_gb Volume size in GB, integer value --interface: --compute-attributes: machine_type network associate_external_ip Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes cpu_mode Possible values: default, host-model, host-passthrough OpenStack: --volume: --interface: --compute-attributes: availability_zone boot_from_volume flavor_ref image_ref tenant_id security_groups network oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs", "Usage: hammer compute-profile values remove-interface [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface-id NUMBER Interface id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile values remove-volume [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume-id NUMBER Volume id -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-profile values update [OPTIONS] Options: --compute-attributes KEY_VALUE_LIST Compute resource attributes, should be comma separated list of values --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values Can be specified multiple times. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --volume: --interface: --compute-attributes: availability_zone flavor_id groups security_group_ids managed_ip GCE: --volume: size_gb Volume size in GB, integer value --interface: --compute-attributes: machine_type network associate_external_ip Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes cpu_mode Possible values: default, host-model, host-passthrough OpenStack: --volume: --interface: --compute-attributes: availability_zone boot_from_volume flavor_ref image_ref tenant_id security_groups network oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs", "Usage: hammer compute-profile values update-interface [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --interface KEY_VALUE_LIST Interface parameters, should be comma separated list of values --interface-id NUMBER Interface id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --interface: GCE: --interface: Libvirt: --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default OpenStack: --interface: oVirt: --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile Rackspace: --interface: VMware: --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware AzureRM: --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false)", "Usage: hammer compute-profile values update-volume [OPTIONS] Options: --compute-profile VALUE Compute profile name --compute-profile-id VALUE --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --volume KEY_VALUE_LIST Volume parameters, should be comma separated list of values --volume-id NUMBER Volume id -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Provider specific options: NOTE: Bold attributes are required. EC2: --volume: GCE: --volume: size_gb Volume size in GB, integer value Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 OpenStack: --volume: oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi Rackspace: --volume: VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite)", "Usage: hammer compute-resource [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: associate-vms Associate VMs to Hosts clusters List available clusters for a compute resource create Create a compute resource delete, destroy Delete a compute resource flavors List available flavors for a compute resource folders List available folders for a compute resource image View and manage compute resource's images images List available images for a compute resource info, show Show a compute resource list, index List all compute resources networks List available networks for a compute resource resource-pools List resource pools for a compute resource cluster security-groups List available security groups for a compute resource storage-domains List storage domains for a compute resource storage-pods List storage pods for a compute resource update Update a compute resource virtual-machine View and manage compute resource's virtual machines virtual-machines List available virtual machines for a compute resource vnic-profiles List available vnic profiles for a compute resource, for RHEV only zones List available zone for a compute resource Options: -h, --help Print help", "Usage: hammer compute-resource associate-vms [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Associate a specific VM -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource clusters [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource create [OPTIONS] Options: --app-ident VALUE Client ID for AzureRm --caching-enabled BOOLEAN Enable caching, for VMware only --cloud VALUE Cloud --datacenter VALUE For RHEV, VMware Datacenter --description VALUE --display-type ENUM For Libvirt and RHEV only Possible value(s): 'VNC', 'SPICE' --domain VALUE For RHEL OpenStack Platform (v3) only --email VALUE Email for GCE only --key-path VALUE Certificate path for GCE only --keyboard-layout ENUM For RHEV only Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --ovirt-quota VALUE For RHEV only, ID or Name of quota to use --password VALUE Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --project VALUE Project id for GCE only --project-domain-id VALUE For RHEL OpenStack Platform (v3) only --project-domain-name VALUE For RHEL OpenStack Platform (v3) only --provider VALUE Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm --public-key VALUE For RHEV only --public-key-path FILE Path to a file that contains oVirt public key (For oVirt only) --region VALUE For AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region --secret-key VALUE Client Secret for AzureRm --server VALUE For VMware --set-console-password BOOLEAN For Libvirt and VMware only --sub-id VALUE Subscription ID for AzureRm --tenant VALUE For RHEL OpenStack Platform and AzureRm only --url VALUE URL for Libvirt, RHEV and RHEL OpenStack Platform --user VALUE Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2. --zone VALUE For GCE only -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource flavors [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource folders [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource image [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: available Show images available for addition create Create an image delete, destroy Delete an image info, show Show an image list, index List all images for a compute resource update Update an image Options: -h, --help Print help", "Usage: hammer compute-resource image available [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Name | x | x | x Uuid | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource image create [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --user-data BOOLEAN Whether or not the image supports user data --username VALUE --uuid VALUE Template ID in the compute resource -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource image <delete|destroy> [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource image <info|show> [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE ID of compute resource --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Operating system | x | x | Username | x | x | Uuid | x | x | User data | x | x | Architecture | x | x | Iam role | x | x | Created at | x | x | Updated at | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource image <list|index> [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE ID of compute resource --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Operating system | x | x | Username | x | x | Uuid | x | x | User data | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: architecture integer compute_resource string name string operatingsystem integer user_data Values: true, false username string", "Usage: hammer compute-resource image update [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --compute-resource VALUE Compute resource name --compute-resource-id VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --user-data BOOLEAN Whether or not the image supports user data --username VALUE --uuid VALUE Template ID in the compute resource -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource images [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Uuid | x | x | Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Provider | x | x | Description | x | x | User | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Provider | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: id integer location string location_id integer name string organization string organization_id integer type string", "Usage: hammer compute-resource networks [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource resource-pools [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource security-groups [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource storage-domains [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --storage-domain VALUE -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource storage-pods [OPTIONS] Options: --cluster-id VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --storage-pod VALUE -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource update [OPTIONS] Options: --app-ident VALUE Client ID for AzureRm --caching-enabled BOOLEAN Enable caching, for VMware only --cloud VALUE Cloud --datacenter VALUE For RHEV, VMware Datacenter --description VALUE --display-type ENUM For Libvirt and RHEV only Possible value(s): 'VNC', 'SPICE' --domain VALUE For RHEL OpenStack Platform (v3) only --email VALUE Email for GCE only --id VALUE --key-path VALUE Certificate path for GCE only --keyboard-layout ENUM For RHEV only Possible value(s): 'ar', 'de-ch', 'es', 'fo', 'fr-ca', 'hu', 'ja', 'mk', 'no', 'pt-br', 'sv', 'da', 'en-gb', 'et', 'fr', 'fr-ch', 'is', 'lt', 'nl', 'pl', 'ru', 'th', 'de', 'en-us', 'fi', 'fr-be', 'hr', 'it', 'lv', 'nl-be', 'pt', 'sl', 'tr' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Compute resource name --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --ovirt-quota VALUE For RHEV only, ID or Name of quota to use --password VALUE Password for RHEV, EC2, VMware, RHEL OpenStack Platform. Secret key for EC2 --project VALUE Project id for GCE only --project-domain-id VALUE For RHEL OpenStack Platform (v3) only --project-domain-name VALUE For RHEL OpenStack Platform (v3) only --provider VALUE Providers include Libvirt, Ovirt, EC2, Vmware, Openstack, GCE, AzureRm --public-key VALUE For RHEV only --public-key-path FILE Path to a file that contains oVirt public key (For oVirt only) --region VALUE For AzureRm eg. 'eastus' and for EC2 only. Use 'us-gov-west-1' for EC2 GovCloud region --secret-key VALUE Client Secret for AzureRm --server VALUE For VMware --set-console-password BOOLEAN For Libvirt and VMware only --sub-id VALUE Subscription ID for AzureRm --tenant VALUE For RHEL OpenStack Platform and AzureRm only --url VALUE URL for Libvirt, RHEV and RHEL OpenStack Platform --user VALUE Username for RHEV, EC2, VMware, RHEL OpenStack Platform. Access Key for EC2. --zone VALUE For GCE only -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource virtual-machine [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Delete a Virtual Machine info, show Show a virtual machine power Power a Virtual Machine Options: -h, --help Print help", "Usage: hammer compute-resource virtual-machine <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Virtual machine id, for gce use virtual machine name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource virtual-machine <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Virtual machine id, for gce use virtual machine name -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource virtual-machine power [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vm-id VALUE Virtual machine id, for gce use virtual machine name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource virtual-machines [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource vnic-profiles [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Vnic profile id | x | x | x Name | x | x | x Network id | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer compute-resource zones [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Compute resource name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer config-report [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Delete a report info, show Show a report list, index List all reports Options: -h, --help Print help", "Usage: hammer config-report <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer config-report <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------|-----|---------|----- Id | x | x | x Host | x | x | Reported at | x | x | Origin | x | x | Report status/applied | x | x | Report status/restarted | x | x | Report status/failed | x | x | Report status/restart failures | x | x | Report status/skipped | x | x | Report status/pending | x | x | Report metrics/config_retrieval | x | x | Report metrics/exec | x | x | Report metrics/file | x | x | Report metrics/package | x | x | Report metrics/service | x | x | Report metrics/user | x | x | Report metrics/yumrepo | x | x | Report metrics/filebucket | x | x | Report metrics/cron | x | x | Report metrics/total | x | x | Logs/resource | x | x | Logs/message | x | x | --------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer config-report <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Host | x | x | Last report | x | x | Origin | x | x | Applied | x | x | Restarted | x | x | Failed | x | x | Restart failures | x | x | Skipped | x | x | Pending | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer", "Usage: hammer content-credentials [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Content Credential delete, destroy Destroy a Content Credential info, show Show a Content Credential list, index List Content Credentials update Update a Content Credential Options: -h, --help Print help", "Usage: hammer content-credentials create [OPTIONS] Options: --content-type VALUE Type of content: \"cert\", \"gpg_key\" --name VALUE Name of the Content Credential --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path FILE Key file -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-credentials <delete|destroy> [OPTIONS] Options: --id NUMBER Content Credential ID --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-credentials <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content Credential numeric identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: --------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | Repositories/id | x | x | Repositories/name | x | x | Repositories/content type | x | x | Repositories/product | x | x | Content | x | x | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-credentials <list|index> [OPTIONS] Options: --content-type VALUE Type of content --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Name of the Content Credential --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Content type | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-credentials update [OPTIONS] Options: --content-type VALUE Type of content: \"cert\", \"gpg_key\" --id NUMBER Content Credential ID --name VALUE Name of the Content Credential --new-name VALUE Name of the Content Credential --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path FILE Key file -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: complete Prepare content for a full export to a disconnected Katello generate-metadata Writes export metadata to disk for use by the importing Katello. This command only needs to be used if the export was performed asynchronously or if the metadata was lost incremental Prepare content for an incremental export to a disconnected Katello list, index View content view export histories Options: -h, --help Print help", "Usage: hammer content-export complete [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Performs a full export of the organization's library environment repository Performs a full export of a repository version Performs a full export a content view version Options: -h, --help Print help", "Usage: hammer content-export complete library [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this organization are unexportable. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export complete repository [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --id NUMBER Repository identifier --name VALUE Filter repositories by name. --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export complete version [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this version are unexportable. --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Filter versions by version number. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export generate-metadata [OPTIONS] Options: --id VALUE Generate metadata based on specified export history --task-id VALUE Generate metadata based on output of the specified export task -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export incremental [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Performs an incremental export of the organization's library environment repository Performs an incremental export of a repository version Performs an incremental export of a content view version Options: -h, --help Print help", "Usage: hammer content-export incremental library [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this organization are unexportable. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export incremental repository [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --id NUMBER Repository identifier --name VALUE Filter repositories by name. --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export incremental version [OPTIONS] Options: --async Do not wait for the task --chunk-size-gb NUMBER Split the exported content into archives no greater than the specified size in gigabytes. --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --destination-server VALUE Destination Server name --fail-on-missing-content Fails if any of the repositories belonging to this version are unexportable. --from-history-id NUMBER Export history identifier used for incremental export. If not provided the most recent export history will be used. --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Filter versions by version number. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-export <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --destination-server VALUE Destination Server name --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --id NUMBER Content view version export history identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --type ENUM Export Types Possible value(s): 'complete', 'incremental' -h, --help Print help Predefined field sets: ------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------|-----|---------|----- Id | x | x | x Destination server | x | x | Path | x | x | Type | x | x | Content view version | x | x | Content view version id | x | x | Created at | x | x | Updated at | x | x | ------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer content_view_version_id integer id integer type string", "Usage: hammer content-import [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: library Imports a content archive to an organization's library lifecycle environment list, index View content view import histories repository Imports a repository version Imports a content archive to a content view version Options: -h, --help Print help", "Usage: hammer content-import library [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-import <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --id NUMBER Content view version import history identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --type ENUM Import Types Possible value(s): 'complete', 'incremental' -h, --help Print help Predefined field sets: ------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------|-----|---------|----- Id | x | x | x Path | x | x | Type | x | x | Content view version | x | x | Content view version id | x | x | Created at | x | x | Updated at | x | x | ------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer content_view_version_id integer id integer type string", "Usage: hammer content-import repository [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-import version [OPTIONS] Options: --async Do not wait for the task --metadata-file VALUE Location of the metadata.json file. This is not required if the metadata.json file is already in the archive directory. --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --path VALUE Directory containing the exported Content View Version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-units [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a content unit list, index List content_units Options: -h, --help Print help", "Usage: hammer content-units <info|show> [OPTIONS] Options: --content-type VALUE Possible values: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A content unit identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Filename | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-units <list|index> [OPTIONS] Options: --content-type VALUE Possible values: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Filename | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-repository Associate a resource add-version Add a content view version to a composite view component View and manage components copy Copy a content view create Create a content view delete Delete a content view filter View and manage filters info, show Show a content view list, index List content views publish Publish a content view purge Delete old versions of a content view remove Remove versions and/or environments from a content view and reassign systems and keys remove-from-environment Remove a content view from an environment remove-repository Disassociate a resource remove-version Remove a content view version from a composite view update Update a content view version View and manage content view versions Options: -h, --help Print help", "Usage: hammer content-view add-repository [OPTIONS] Options: --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view add-version [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view id to search by --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view component [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add Add components to the content view list, index List components attached to this content view remove Remove components from the content view update Update a component associated with the content view Options: -h, --help Print help", "Usage: hammer content-view component add [OPTIONS] Options: --component-content-view VALUE Content View name of the component who's latest version is desired --component-content-view-id VALUE Content View identifier of the component who's latest version is desired --component-content-view-version VALUE Content View Version number of the component. Either use this or --component-content-view-version-id option --component-content-view-version-id VALUE Content View Version identifier of the component --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --latest Select the latest version of the components content view is desired --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view component <list|index> [OPTIONS] Options: --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --fields LIST Show specified fields or predefined field sets only. (See below) --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Id | x | x | x Name | x | x | Version | x | x | Current version | x | x | Version id | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view component remove [OPTIONS] Options: --component-content-view-ids VALUE Array of component content view identfiers to remove. Comma separated list of values --component-content-views VALUE Array of component content view names to remove. Comma separated list of values --component-ids LIST Array of content view component IDs to remove. Identifier of the component association --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view component update [OPTIONS] Options: --component-content-view VALUE Content View name of the component who's latest version is desired --component-content-view-id VALUE Content View identifier of the component who's latest version is desired --component-content-view-version VALUE Content View Version number of the component. Either use this or --component-content-view-version-id option --component-content-view-version-id VALUE Content View Version identifier of the component --composite-content-view VALUE Name of the composite content view --composite-content-view-id NUMBER Composite content view identifier --id NUMBER Content view component ID. Identifier of the component association --latest Select the latest version of the components content view is desired --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view copy [OPTIONS] Options: --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --new-name VALUE New content view name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view create [OPTIONS] Options: --auto-publish BOOLEAN Enable/Disable auto publish of composite view --component-ids LIST List of component content view version ids for composite views --composite Create a composite content view --description VALUE Description for the content view --import-only Designate this Content View for importing from upstream servers only. --label VALUE Content view label --name VALUE Name of the content view --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository-ids LIST List of repository ids --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view delete [OPTIONS] Options: --async Do not wait for the task --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-repository Associate a resource create Create a filter for a content view delete, destroy Delete a filter info, show Show filter info list, index List filters remove-repository Disassociate a resource rule View and manage filter rules update Update a filter Options: -h, --help Print help", "Usage: hammer content-view filter add-repository [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --id VALUE Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter create [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --description VALUE Description of the filter --inclusion BOOLEAN Specifies if content should be included or excluded, default: inclusion=false --name VALUE Name of the filter --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only) --original-packages BOOLEAN Add all packages without errata to the included/excluded list. (package filter only) --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repositories LIST --repository-ids LIST List of repository ids --type VALUE Type of filter (e.g. rpm, package_group, erratum, erratum_id, erratum_date, docker, modulemd) -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter <delete|destroy> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --id NUMBER Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Filter id | x | x | x Name | x | x | x Type | x | x | Inclusion | x | x | Description | x | x | Repositories/id | x | x | Repositories/name | x | x | Repositories/label | x | x | Rules/id | x | x | Rules/name | x | x | Rules/version | x | x | Rules/minimum version | x | x | Rules/maximum version | x | x | Rules/errata id | x | x | Rules/start date | x | x | Rules/end date | x | x | Rules/types | x | x | Rules/created | x | x | Rules/updated | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Filter content view filters by name --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --types LIST Types of filters -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Filter id | x | x | x Name | x | x | x Description | x | x | Type | x | x | Inclusion | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_type Values: rpm, package_group, erratum, docker, modulemd inclusion_type Values: include, exclude name string", "Usage: hammer content-view filter remove-repository [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --id VALUE Filter identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter rule [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a filter rule. The parameters included should be based upon the filter type. delete, destroy Delete a filter rule info, show Show filter rule info list, index List filter rules update Update a filter rule. The parameters included should be based upon the filter type. Options: -h, --help Print help", "Usage: hammer content-view filter rule create [OPTIONS] Options: --architecture VALUE Package: architecture --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --date-type VALUE Erratum: search using the 'Issued On' or 'Updated On' column of the errata. Values are 'issued'/'updated' --end-date VALUE Erratum: end date (YYYY-MM-DD) --errata-id VALUE Erratum: id --errata-ids LIST Erratum: IDs or a select all object --max-version VALUE Package: maximum version --min-version VALUE Package: minimum version --module-stream-ids LIST Module stream ids --name LIST Package, package group, or docker tag names --names VALUE Package and package group names --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --start-date VALUE Erratum: start date (YYYY-MM-DD) --types LIST Erratum: types (enhancement, bugfix, security) --uuid VALUE Package group: uuid --version VALUE Package: version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter rule <delete|destroy> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --id NUMBER Rule identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter rule <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Rule identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Rule id | x | x | x Filter id | x | x | Name | x | x | x Version | x | x | Minimum version | x | x | Maximum version | x | x | Architecture | x | x | Errata id | x | x | Start date | x | x | End date | x | x | Date type | x | x | Types | x | x | Created | x | x | Updated | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter rule <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --errata-id VALUE Errata_id of the content view filter rule --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --name VALUE Name of the content view filter rule --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Rule id | x | x | x Filter id | x | x | Name | x | x | x Version | x | x | Minimum version | x | x | Maximum version | x | x | Architecture | x | x | Errata id | x | x | Start date | x | x | End date | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter rule update [OPTIONS] Options: --architecture VALUE Package: architecture --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Filter identifier --content-view-id NUMBER --end-date VALUE Erratum: end date (YYYY-MM-DD) --errata-id VALUE Erratum: id --id NUMBER Rule identifier --max-version VALUE Package: maximum version --min-version VALUE Package: minimum version --name VALUE Package, package group, or docker tag: name --new-name VALUE Package, package group, or docker tag: name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --start-date VALUE Erratum: start date (YYYY-MM-DD) --types LIST Erratum: types (enhancement, bugfix, security) --version VALUE Package: version -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view filter update [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --description VALUE Description of the filter --id NUMBER Filter identifier --inclusion BOOLEAN Specifies if content should be included or excluded, default: inclusion=false --name VALUE New name for the filter --new-name VALUE New name for the filter --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --original-module-streams BOOLEAN Add all module streams without errata to the included/excluded list. (module stream filter only) --original-packages BOOLEAN Add all packages without errata to the included/excluded list. (package filter only) --repositories LIST --repository-ids LIST List of repository ids -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Predefined field sets: -----------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Label | x | x | Composite | x | x | Description | x | x | Content host count | x | x | Solve dependencies | x | x | Organization | x | x | Yum repositories/id | x | x | Yum repositories/name | x | x | Yum repositories/label | x | x | Container image repositories/id | x | x | Container image repositories/name | x | x | Container image repositories/label | x | x | Ostree repositories/id | x | x | Ostree repositories/name | x | x | Ostree repositories/label | x | x | Lifecycle environments/id | x | x | Lifecycle environments/name | x | x | Versions/id | x | x | Versions/version | x | x | Versions/published | x | x | Components/id | x | x | Components/name | x | x | Activation keys/ | x | x | -----------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view <list|index> [OPTIONS] Options: --composite BOOLEAN Filter only composite content views --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --include-generated BOOLEAN Include content views generated by imports/exports. Defaults to false --label VALUE Label of the content view --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --name VALUE Name of the content view --noncomposite BOOLEAN Filter out composite content views --nondefault BOOLEAN Filter out default content views --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --without LIST Do not include this array of content views -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Content view id | x | x | x Name | x | x | x Label | x | x | Composite | x | x | Last published | x | x | Repository ids | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: composite boolean generated_for integer label string name string organization_id integer", "Usage: hammer content-view publish [OPTIONS] Options: --async Do not wait for the task --description VALUE Description for the new published content view version --id NUMBER Content view identifier --is-force-promote BOOLEAN Force content view promotion and bypass lifecycle environment restriction --lifecycle-environment-ids LIST Identifiers for Lifecycle Environment --lifecycle-environments LIST Names for Lifecycle Environment --major NUMBER Override the major version number --minor NUMBER Override the minor version number --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --repos-units SCHEMA Specify the list of units in each repo -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --repos-units \"label=<string>\\,rpm_filenames=<array>, ... \"", "Usage: hammer content-view purge [OPTIONS] Options: --async Do not wait for the task --count NUMBER Count of unused versions to keep Default: 3 --id VALUE Content View numeric identifier --name VALUE Content View name --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view remove [OPTIONS] Options: --async Do not wait for the task --content-view-version-ids LIST Content view version identifiers to be deleted --content-view-versions LIST --destroy-content-view BOOLEAN Delete the content view with all the versions and environments --environment-ids LIST (--environment-ids is deprecated: Use --lifecycle-environment-ids instead) --environments LIST (--environments is deprecated: Use --lifecycle-environments instead) --id NUMBER Content view numeric identifier --key-content-view-id NUMBER Content view to reassign orphaned activation keys to --key-environment-id NUMBER Environment to reassign orphaned activation keys to --lifecycle-environment-ids LIST Environment numeric identifiers to be removed --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --system-content-view-id NUMBER Content view to reassign orphaned systems to --system-environment-id NUMBER Environment to reassign orphaned systems to -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view remove-from-environment [OPTIONS] Options: --async Do not wait for the task --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view numeric identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view remove-repository [OPTIONS] Options: --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view remove-version [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --id VALUE Content view numeric identifier --name VALUE Content view name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view update [OPTIONS] Options: --auto-publish BOOLEAN Enable/Disable auto publish of composite view --component-ids LIST List of component content view version ids for composite views --description VALUE Description for the content view --id NUMBER Content view identifier --import-only BOOLEAN Designate this Content View for importing from upstream servers only. Defaults to false --name VALUE New name for the content view --new-name VALUE New name for the content view --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --repository-ids LIST List of repository ids --solve-dependencies BOOLEAN Solve RPM dependencies by default on Content View publish, defaults to false -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete Remove content view version incremental-update Perform an Incremental Update on one or more Content View Versions info, show Show content view version list, index List content view versions promote Promote a content view version republish-repositories Forces a republish of the version's repositories' metadata update Update a content view version Options: -h, --help Print help", "Usage: hammer content-view version delete [OPTIONS] Options: --async Do not wait for the task --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version incremental-update [OPTIONS] Options: --async Do not wait for the task --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version Ids to perform an incremental update on. May contain composites as well as one or more components to update. --deb-ids LIST Deb Package ids to copy into the new versions --debs LIST --description VALUE The description for the new generated Content View Versions --errata-ids LIST Errata ids to copy into the new versions --host-ids LIST IDs of hosts to update --lifecycle-environment-ids LIST List of lifecycle environment IDs to update the content view version in --lifecycle-environments LIST List of lifecycle environment names to update the content view version in --organization VALUE Organization name for resolving lifecycle environment names --organization-id VALUE Organization id for resolving lifecycle environment names --package-ids LIST Package ids to copy into the new versions --packages LIST --propagate-all-composites BOOLEAN If true, will publish a new composite version using any specified content_view_version_id that has been promoted to a lifecycle environment --resolve-dependencies BOOLEAN If true, when adding the specified errata or packages, any needed dependencies will be copied as well. Defaults to true --update-all-hosts BOOLEAN Update all editable and applicable hosts within the specified Content View and Lifecycle Environments -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Predefined field sets: -----------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------------|-----|---------|----- Id | x | x | x Name | x | x | Version | x | x | x Description | x | x | Content view id | x | x | Content view name | x | x | Content view label | x | x | Lifecycle environments/id | x | x | Lifecycle environments/name | x | x | Lifecycle environments/label | x | x | Repositories/id | x | x | Repositories/name | x | x | Repositories/label | x | x | -----------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version <list|index> [OPTIONS] Options: --composite-version-id NUMBER Filter versions that are components in the specified composite version --content-view VALUE Content view name to search by --content-view-id NUMBER Content view identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Filter versions by environment --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --triggered-by-id NUMBER Filter composite versions whose publish was triggered by the specified component version --version VALUE Filter versions by version number -h, --help Print help Predefined field sets: -----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------|-----|---------|----- Id | x | x | x Name | x | x | Version | x | x | x Description | x | x | Lifecycle environments | x | x | -----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_view_id integer repository string version string", "Usage: hammer content-view version promote [OPTIONS] Options: --async Do not wait for the task --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --description VALUE The description for the content view version promotion --force Force content view promotion and bypass lifecycle environment restriction --from-lifecycle-environment VALUE Environment name from where to promote its version from (if version is unknown) --from-lifecycle-environment-id VALUE Id of the environment from where to promote its version from (if version is unknown) --id NUMBER Content view version identifier --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --to-lifecycle-environment VALUE Name of the target environment --to-lifecycle-environment-id VALUE Id of the target environment --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version republish-repositories [OPTIONS] Options: --async Do not wait for the task --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --force BOOLEAN Force metadata regeneration to proceed. Dangerous when repositories use the 'Complete Mirroring' mirroring policy --id NUMBER Content view version identifier --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer content-view version update [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --description VALUE The description for the content view version --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Content view version identifier --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of the environment --new-version VALUE --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --version VALUE Content view version number -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer deb-package [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a deb package list, index List deb packages Options: -h, --help Print help", "Usage: hammer deb-package <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A deb package identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Pulp id | x | x | Uuid | x | x | Name | x | x | x Version | x | x | Checksum | x | x | Architecture | x | x | Nav | x | x | Nva | x | x | Filename | x | x | Available host count | x | x | Applicable host count | x | x | Description | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer deb-package <list|index> [OPTIONS] Options: --available-for VALUE Return deb packages that can be added to the specified object. Only the value 'content_view_version' is supported. --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content View Filter identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Host id to list applicable deb packages for --ids LIST Deb package identifiers to filter content by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages-restrict-applicable BOOLEAN Return deb packages that are applicable to one or more hosts (defaults to true if host_id is specified) --packages-restrict-upgradable BOOLEAN Return deb packages that are upgradable on one or more hosts --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------|-----|-------- FIELDS | ALL | DEFAULT ---------|-----|-------- Id | x | x Filename | x | x ---------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer defaults [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add Add a default parameter to config delete Delete a default param list List all the default parameters providers List all the providers Options: -h, --help Print help", "Usage: hammer defaults add [OPTIONS] Options: --param-name VALUE The name of the default option (e.g. organization_id) --param-value VALUE The value for the default option --provider VALUE The name of the provider providing the value. For list available providers see `hammer defaults providers` -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer defaults delete [OPTIONS] Options: --param-name VALUE The name of the default option -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer defaults list [OPTIONS] Options: -h, --help Print help", "Usage: hammer defaults providers [OPTIONS] Options: -h, --help Print help", "Usage: hammer discovery [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: auto-provision Auto provision a host delete, destroy Delete a discovered host facts List all fact values info, show Show a discovered host list, index List all discovered hosts provision Provision a discovered host reboot Reboot a host refresh-facts Refresh the facts of a host Options: -h, --help Print help", "Usage: hammer discovery auto-provision [OPTIONS] Options: --all Auto provision all discovered hosts --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery facts [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|-------- FIELDS | ALL | DEFAULT -------|-----|-------- Fact | x | x Value | x | x -------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fact string fact_short_name string facts string host string host.hostgroup string host_id integer location string location_id integer name string organization string organization_id integer origin string reported_at datetime short_name string type string value string", "Usage: hammer discovery <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Mac | x | x | Cpus | x | x | Memory | x | x | Disk count | x | x | Disks size | x | x | Subnet | x | x | Last report | x | x | Ip | x | x | Model | x | x | Organization | x | x | Location | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort results --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page VALUE Paginate results --per-page VALUE Number of entries per request --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Mac | x | x | Cpus | x | x | Memory | x | x | Disk count | x | x | Disks size | x | x | Subnet | x | x | Last report | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery provision [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id NUMBER Required if host is managed and value is not inherited from host group --ask-root-password BOOLEAN --build BOOLEAN --capabilities VALUE --domain VALUE Domain name --domain-id NUMBER Required if host is managed and value is not inherited from host group --enabled BOOLEAN --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE --image VALUE Name to search by --image-id NUMBER --interface KEY_VALUE_LIST Interface parameters Can be specified multiple times. --ip VALUE Not required if using a subnet with DHCP Capsule --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE Not required if it's a virtual machine --managed BOOLEAN --medium VALUE Medium name --medium-id VALUE Required if not imaged based provisioning and host is managed and value is not inherited from host group --model VALUE Model name --model-id NUMBER --name VALUE --new-name VALUE --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Required if host is managed and value is not inherited from host group --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --overwrite BOOLEAN --owner-id NUMBER --owner-type ENUM Host's owner type Possible value(s): 'User', 'Usergroup' --parameters KEY_VALUE_LIST Host parameters --partition-table VALUE Partition table name --partition-table-id NUMBER --progress-report-id VALUE UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks --provision-method ENUM Possible value(s): 'build', 'image' --pxe-loader ENUM DHCP filename option (Grub2 or PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --root-password VALUE --sp-subnet-id NUMBER --subnet VALUE Subnet name --subnet-id NUMBER Required if host is managed and value is not inherited from host group -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery reboot [OPTIONS] Options: --all Reboot all discovered hosts --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery refresh-facts [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery-rule [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a discovery rule delete, destroy Delete a rule info, show Show a discovery rule list, index List all discovery rules update Update a rule Options: -h, --help Print help", "Usage: hammer discovery-rule create [OPTIONS] Options: --enabled BOOLEAN Flag is used for temporary shutdown of rules --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER The hostgroup that is used to auto provision a host --hostgroup-title VALUE Hostgroup title --hostname VALUE Defines a pattern to assign human-readable hostnames to the matching hosts --hosts-limit VALUE Enables to limit maximum amount of provisioned hosts per rule --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Location ID for provisioned hosts --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Represents rule name shown to the users --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Organization ID for provisioned hosts --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --priority NUMBER Puts the rules in order, low numbers go first. Must be greater then zero --search VALUE Query to match discovered hosts for the particular rule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery-rule <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery-rule <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------|-----|---------|----- Id | x | x | x Name | x | x | x Priority | x | x | Search | x | x | Host group | x | x | Hosts limit | x | x | Enabled | x | x | Hostname template | x | x | Hosts/ | x | x | Locations/ | x | x | Organizations/ | x | x | ------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery-rule <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort results --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page VALUE Paginate results --per-page VALUE Number of entries per request --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Priority | x | x | Search | x | x | Host group | x | x | Hosts limit | x | x | Enabled | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer discovery-rule update [OPTIONS] Options: --enabled BOOLEAN Flag is used for temporary shutdown of rules --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER The hostgroup that is used to auto provision a host --hostgroup-title VALUE Hostgroup title --hostname VALUE Defines a pattern to assign human-readable hostnames to the matching hosts --hosts-limit VALUE Enables to limit maximum amount of provisioned hosts per rule --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Location ID for provisioned hosts --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Represents rule name shown to the users --new-name VALUE Represents rule name shown to the users --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Organization ID for provisioned hosts --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --priority NUMBER Puts the rules in order, low numbers go first. Must be greater then zero --search VALUE Query to match discovered hosts for the particular rule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer docker [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: manifest Manage docker manifests tag Manage docker tags Options: -h, --help Print help", "Usage: hammer docker manifest [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a docker manifest list, index List docker_manifests Options: -h, --help Print help", "Usage: hammer docker manifest <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A docker manifest identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Schema version | x | x | Digest | x | x | Downloaded | x | x | Tags/name | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer docker manifest <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Schema version | x | x | Digest | x | x | Downloaded | x | x | Tags | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer docker tag [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a docker tag list, index List docker_tags Options: -h, --help Print help", "Usage: hammer docker tag <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A docker tag identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------|-----|---------|----- Id | x | x | x Tag | x | x | x Repository id | x | x | Docker manifest id | x | x | Docker manifest name | x | x | ---------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer docker tag <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Tag | x | x | x Repository id | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a domain delete, destroy Delete a domain delete-parameter Delete parameter for a domain info, show Show a domain list, index List of domains set-parameter Create or update parameter for a domain update Update a domain Options: -h, --help Print help", "Usage: hammer domain create [OPTIONS] Options: --description VALUE Full name describing the domain --dns VALUE Name of DNS proxy to use within this domain --dns-id VALUE ID of DNS proxy to use within this domain --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The full DNS domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain delete-parameter [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --name VALUE Parameter name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Numerical ID or domain name --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Dns id | x | x | Subnets/ | x | x | Locations/ | x | x | Organizations/ | x | x | Parameters/ | x | x | Created at | x | x | Updated at | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --subnet VALUE Subnet name --subnet-id VALUE ID of subnet -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fullname string location string location_id integer name string organization string organization_id integer params string", "Usage: hammer domain set-parameter [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer domain update [OPTIONS] Options: --description VALUE Full name describing the domain --dns VALUE Name of DNS proxy to use within this domain --dns-id VALUE ID of DNS proxy to use within this domain --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The full DNS domain name --new-name VALUE The full DNS domain name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer erratum [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info Show an erratum list, index List errata Options: -h, --help Print help", "Usage: hammer erratum info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE An erratum identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ------------------------|-----|-------- FIELDS | ALL | DEFAULT ------------------------|-----|-------- Title | x | x Version | x | x Description | x | x Status | x | x Id | x | x Errata id | x | x Reboot suggested | x | x Updated | x | x Issued | x | x Release | x | x Solution | x | x Packages | x | x Module streams/name | x | x Module streams/stream | x | x Module streams/packages | x | x ------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer erratum <list|index> [OPTIONS] Options: --available-for VALUE Return errata that can be added to the specified object. The values 'content_view_version' and 'content_view_filter are supported. --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content View Filter identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version identifier --cve VALUE CVE identifier --errata-restrict-applicable BOOLEAN Return errata that are applicable to one or more hosts (defaults to true if host_id is specified) --errata-restrict-installable BOOLEAN Return errata that are upgradable on one or more hosts --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Host id to list applicable errata for --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ----------|-----|-------- FIELDS | ALL | DEFAULT ----------|-----|-------- Id | x | x Errata id | x | x Type | x | x Title | x | x Issued | x | x Updated | x | x ----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: bug string cve string errata_id string errata_type string id string issued date modular Values: true, false package string package_name string reboot_suggested boolean repository string severity string synopsis string title string type string updated date", "Usage: hammer export-templates [OPTIONS] Options: --branch VALUE Branch in Git repo. --commit-msg VALUE Custom commit message for templates export --dirname VALUE The directory within Git repo containing the templates --filter VALUE Export templates with names matching this regex (case-insensitive; snippets are not filtered). --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --metadata-export-mode ENUM Specify how to handle metadata Possible value(s): 'refresh', 'keep', 'remove' --negate BOOLEAN Negate the prefix (for purging). --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --repo VALUE Override the default repo from settings. --verbose BOOLEAN Be verbose -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer fact [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: list, index List all fact values Options: -h, --help Print help", "Usage: hammer fact <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|-------- FIELDS | ALL | DEFAULT -------|-----|-------- Host | x | x Fact | x | x Value | x | x -------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fact string fact_short_name string facts string host string host.hostgroup string host_id integer location string location_id integer name string organization string organization_id integer origin string reported_at datetime short_name string type string value string", "Usage: hammer file [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a file list, index List files Options: -h, --help Print help", "Usage: hammer file <info|show> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A file identifier --name VALUE File name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | Name | x | x | x Path | x | x | Uuid | x | x | Checksum | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer file <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | Name | x | x | x Path | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer filter [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: available-permissions List all permissions available-resources List available resource types create Create a filter delete, destroy Delete a filter info, show Show a filter list, index List all filters update Update a filter Options: -h, --help Print help", "Usage: hammer filter available-permissions [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Resource | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string resource_type string", "Usage: hammer filter available-resources [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer filter create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --override BOOLEAN --permission-ids LIST --permissions LIST --role VALUE User role name --role-id VALUE --search VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Overriding organizations and locations: Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true. Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.", "Usage: hammer filter <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer filter <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Resource type | x | x | Search | x | x | Unlimited? | x | x | Override? | x | x | Role | x | x | Permissions | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer filter <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Resource type | x | x | Search | x | x | Unlimited? | x | x | Override? | x | x | Role | x | x | Permissions | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: limited Values: true, false location string location_id integer organization string organization_id integer override Values: true, false permission string resource string role string role_id integer search text unlimited Values: true, false", "Usage: hammer filter update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --override BOOLEAN --permission-ids LIST --permissions LIST --role VALUE User role name --role-id VALUE --search VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Overriding organizations and locations: Filters inherit organizations and locations from its role by default. This behavior can be changed by setting --override=true. Therefore options --organization[s|-ids] and --location[s|-ids] are applicable only when the override flag is set.", "Usage: hammer foreign-input-set [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a foreign input set delete, destroy Delete a foreign input set info, show Show foreign input set details list, index List foreign input sets update Update a foreign input set Options: -h, --help Print help", "Usage: hammer foreign-input-set create [OPTIONS] Options: --description VALUE Input set description --exclude VALUE A comma separated list of input names to be included from the foreign template. --include VALUE A comma separated list of input names to be included from the foreign template. --include-all BOOLEAN Include all inputs from the foreign template --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --target-template-id VALUE Target template ID --template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer foreign-input-set <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer foreign-input-set <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --template-id VALUE -h, --help Print help Predefined field sets: ---------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------|-----|---------|----- Id | x | x | x Name | x | x | x Target template id | x | x | Target template name | x | x | Include all | x | x | Include | x | x | Exclude | x | x | ---------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer foreign-input-set <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --template-id VALUE -h, --help Print help Predefined field sets: ---------------------|-----|-------- FIELDS | ALL | DEFAULT ---------------------|-----|-------- Id | x | x Target template id | x | x Target template name | x | x ---------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer foreign-input-set update [OPTIONS] Options: --description VALUE Input set description --exclude VALUE A comma separated list of input names to be included from the foreign template. --id VALUE --include VALUE A comma separated list of input names to be included from the foreign template. --include-all BOOLEAN Include all inputs from the foreign template --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --target-template-id VALUE Target template ID --template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer full-help [OPTIONS] Options: --md Format output in markdown -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer global-parameter [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Delete a global parameter list, index List all global parameters set Set a global parameter Options: -h, --help Print help", "Usage: hammer global-parameter <delete|destroy> [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Common parameter name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer global-parameter <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --show-hidden BOOLEAN Display hidden values -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Name | x | x | x Value | x | x | Type | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: domain_name string host_group_name string host_name string key_type string location_name string name string organization_name string os_name string parameter_type string subnet_name text type string value text", "Usage: hammer global-parameter set [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: ansible-roles Manage Ansible roles on a host boot Boot host from specified device config-reports List all reports create Create a host deb-package Manage deb packages on your hosts delete, destroy Delete a host delete-parameter Delete parameter for a host disassociate Disassociate a host enc-dump Dump host's ENC YAML errata Manage errata on your hosts facts List all fact values info, show Show a host interface View and manage host's network interfaces list, index List all hosts package Manage packages on your hosts package-group Manage package-groups on your hosts policies-enc View policies ENC for host reboot Reboot a host rebuild-config Rebuild orchestration related configurations for host reports List all reports reset Reset a host set-parameter Create or append a parameter for a host start Power a host on status Get status of host stop Power a host off subscription Manage subscription information on your hosts traces List traces on your hosts update Update a host Options: -h, --help Print help", "Usage: hammer host ansible-roles [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: assign Assigns Ansible roles to a host list, index List all Ansible roles for a host play Runs all Ansible roles on a host Options: -h, --help Print help", "Usage: hammer host ansible-roles assign [OPTIONS] Options: --ansible-role-ids LIST Ansible roles to assign to a host --ansible-roles LIST --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host ansible-roles <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host ansible-roles play [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host boot [OPTIONS] Options: --device VALUE Boot device, valid devices are disk, cdrom, pxe, bios --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host config-reports [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Host id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Host | x | x | Last report | x | x | Origin | x | x | Applied | x | x | Restarted | x | x | Failed | x | x | Restart failures | x | x | Skipped | x | x | Pending | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer", "Usage: hammer host create [OPTIONS] Options: --ansible-role-ids LIST IDs of associated ansible roles --ansible-roles LIST --architecture VALUE Architecture name --architecture-id NUMBER Required if host is managed and value is not inherited from host group --ask-root-password BOOLEAN --autoheal BOOLEAN Sets whether the Host will autoheal subscriptions upon checkin --build BOOLEAN --comment VALUE Additional information about this host --compute-attributes KEY_VALUE_LIST Compute resource attributes --compute-profile VALUE Compute profile name --compute-profile-id NUMBER --compute-resource VALUE Compute resource name --compute-resource-id NUMBER Nil means host is bare metal --content-source VALUE Content Source name --content-source-id NUMBER --content-view VALUE Name to search by --content-view-id NUMBER --domain VALUE Domain name --domain-id NUMBER Required if host is managed and value is not inherited from host group --enabled BOOLEAN Include this host within Satellite reporting --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --hypervisor-guest-uuids LIST List of hypervisor guest uuids --image VALUE Name to search by --image-id NUMBER --installed-products-attributes SCHEMA List of products installed on the host --interface KEY_VALUE_LIST Interface parameters Can be specified multiple times. --ip VALUE Not required if using a subnet with DHCP Capsule --kickstart-repository VALUE Kickstart repository name --kickstart-repository-id NUMBER Repository Id associated with the kickstart repo used for provisioning --lifecycle-environment VALUE Name to search by --lifecycle-environment-id NUMBER --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE Required for managed host that is bare metal, not required if it's a virtual machine --managed BOOLEAN True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not --medium VALUE Medium name --medium-id VALUE Required if not imaged based provisioning and host is managed and value is not inherited from host group --model VALUE Model name --model-id NUMBER --name VALUE --openscap-proxy-id NUMBER ID of OpenSCAP Capsule --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Required if host is managed and value is not inherited from host group --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --overwrite BOOLEAN Default: \"true\" --owner VALUE Login of the owner --owner-id VALUE ID of the owner --owner-type ENUM Host's owner type Possible value(s): 'User', 'Usergroup' --parameters KEY_VALUE_LIST Replaces with new host parameters --partition-table VALUE Partition table name --partition-table-id NUMBER Required if host is managed and custom partition has not been defined --product VALUE Name to search by --product-id NUMBER Product id as listed from a host's installed products, this is not the same product id as the products api returns --progress-report-id VALUE UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks --provision-method ENUM The method used to provision the host. Possible value(s): 'build', 'image', 'bootdisk' --puppet-ca-proxy-id NUMBER Puppet CA Capsule ID --puppet-proxy-id NUMBER Puppet Capsule ID --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --pxe-loader ENUM DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --realm VALUE Name to search by --realm-id NUMBER --release-version VALUE Release version for this Host to use (7Server, 7.1, etc) --root-password VALUE Required if host is managed and value is not inherited from host group or default password in settings --service-level VALUE Service level to be used for autoheal --subnet VALUE Subnet name --subnet-id NUMBER Required if host is managed and value is not inherited from host group --typed-parameters SCHEMA Replaces with new host parameters (with type support) --volume KEY_VALUE_LIST Volume parameters Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --typed-parameters \"name=<string>\\,value=<string>\\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\\,hidden_value=[true|false|1|0], ... \" --installed-products-attributes \"product_id=<string>\\,product_name=<string>\\,arch=<string>\\,version=<string>, ... \" Available keys for --interface: mac ip type Possible values: interface, bmc, bond, bridge name subnet_id domain_id identifier managed true/false primary true/false, each managed hosts needs to have one primary interface. provision true/false virtual true/false For virtual=true: tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. attached_to Identifier of the interface to which this interface belongs, e.g. eth1. For type=bond: mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2] bond_options For type=bmc: provider always IPMI username password Provider specific options: NOTE: Bold attributes are required. EC2: --volume: --interface: --compute-attributes: availability_zone flavor_id groups security_group_ids managed_ip GCE: --volume: size_gb Volume size in GB, integer value --interface: --compute-attributes: machine_type network associate_external_ip Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes cpu_mode Possible values: default, host-model, host-passthrough start Boolean (expressed as 0 or 1), whether to start the machine or not OpenStack: --volume: --interface: --compute-attributes: availability_zone boot_from_volume flavor_ref image_ref tenant_id security_groups network oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. start Boolean, set 1 to start the vm Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) start Must be a 1 or 0, whether to start the machine or not AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs", "Usage: hammer host deb-package [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: list, index List deb packages installed on the host Options: -h, --help Print help", "Usage: hammer host deb-package <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER ID of the host --order VALUE Sort field and order, eg. 'id DESC' --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: --------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Arch | x | x | --------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host delete-parameter [OPTIONS] Options: --host VALUE Host name --host-id NUMBER --name VALUE Parameter name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host disassociate [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host enc-dump [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host errata [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: apply Schedule errata for installation using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. info Retrieve a single errata for a host list List errata available for the content host recalculate Force regenerate applicability. Options: -h, --help Print help", "Usage: hammer host errata apply [OPTIONS] Options: --async Do not wait for the task --errata-ids LIST List of Errata ids to install. Will be removed in a future release --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Host ID --order VALUE Sort field and order, eg. 'id DESC' --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string for erratum to perform an action on --sort-by VALUE Field to sort the results on --sort-order VALUE How to order the sorted results (e.g. ASC for ascending) -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host errata info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --host VALUE Host name --host-id NUMBER Host ID --id VALUE Errata id of the erratum (RHSA-2012:108) --name VALUE Name to search by -h, --help Print help Predefined field sets: ------------------------|-----|-------- FIELDS | ALL | DEFAULT ------------------------|-----|-------- Title | x | x Version | x | x Description | x | x Status | x | x Id | x | x Errata id | x | x Reboot suggested | x | x Updated | x | x Issued | x | x Release | x | x Solution | x | x Packages | x | x Module streams/name | x | x Module streams/stream | x | x Module streams/packages | x | x ------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host errata list [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Calculate Applicable Errata based on a particular Content View --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER UUID of the content host --include-applicable BOOLEAN Return errata that are applicable to this host. Defaults to false) --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Calculate Applicable Errata based on a particular Environment --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --severity VALUE Return only errata of a particular severity (None, Low, Moderate, Important, Critical) --type VALUE Return only errata of a particular type (security, bugfix, enhancement) -h, --help Print help Predefined field sets: ------------|-----|-------- FIELDS | ALL | DEFAULT ------------|-----|-------- Id | x | x Erratum id | x | x Type | x | x Title | x | x Installable | x | x ------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host errata recalculate [OPTIONS] Options: --host VALUE Host name --host-id NUMBER Host ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host facts [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|-------- FIELDS | ALL | DEFAULT -------|-----|-------- Fact | x | x Value | x | x -------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: fact string fact_short_name string facts string host string host.hostgroup string host_id integer location string location_id integer name string organization string organization_id integer origin string reported_at datetime short_name string type string value string", "Usage: hammer host <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values -h, --help Print help Predefined field sets: --------------------------------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------------------------------|-----|---------|----- Id | x | x | x Uuid | x | x | Name | x | x | x Organization | x | x | Location | x | x | Host group | x | x | Compute resource | x | x | Compute profile | x | x | Cert name | x | x | Managed | x | x | Installed at | x | x | Last report | x | x | Uptime (seconds) | x | x | Status/global status | x | x | Status/build status | x | x | Network/ipv4 address | x | x | Network/ipv6 address | x | x | Network/mac | x | x | Network/subnet ipv4 | x | x | Network/subnet ipv6 | x | x | Network/domain | x | x | Network/service provider/sp name | x | x | Network/service provider/sp ip | x | x | Network/service provider/sp mac | x | x | Network/service provider/sp subnet | x | x | Network interfaces/id | x | x | Network interfaces/identifier | x | x | Network interfaces/type | x | x | Network interfaces/mac address | x | x | Network interfaces/ipv4 address | x | x | Network interfaces/ipv6 address | x | x | Network interfaces/fqdn | x | x | Operating system/architecture | x | x | Operating system/operating system | x | x | Operating system/build | x | x | Operating system/medium | x | x | Operating system/partition table | x | x | Operating system/pxe loader | x | x | Operating system/custom partition table | x | x | Operating system/image | x | x | Operating system/image file | x | x | Operating system/use image | x | x | Parameters/ | x | x | All parameters/ | x | x | Additional info/owner | x | x | Additional info/owner id | x | x | Additional info/owner type | x | x | Additional info/enabled | x | x | Additional info/model | x | x | Additional info/comment | x | x | Openscap proxy | x | x | Content information/content view/id | x | x | Content information/content view/name | x | x | Content information/lifecycle environment/id | x | x | Content information/lifecycle environment/name | x | x | Content information/content source/id | x | x | Content information/content source/name | x | x | Content information/kickstart repository/id | x | x | Content information/kickstart repository/name | x | x | Content information/applicable packages | x | x | Content information/upgradable packages | x | x | Content information/applicable errata/enhancement | x | x | Content information/applicable errata/bug fix | x | x | Content information/applicable errata/security | x | x | Subscription information/uuid | x | x | Subscription information/last checkin | x | x | Subscription information/release version | x | x | Subscription information/autoheal | x | x | Subscription information/registered to | x | x | Subscription information/registered at | x | x | Subscription information/registered by activation keys/ | x | x | Subscription information/system purpose/service level | x | x | Subscription information/system purpose/purpose usage | x | x | Subscription information/system purpose/purpose role | x | x | Subscription information/system purpose/purpose addons | x | x | Trace status | x | x | Host collections/id | x | x | Host collections/name | x | x | --------------------------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host interface [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an interface on a host delete, destroy Delete a host's interface info, show Show an interface for host list, index List all interfaces for host update Update a host's interface Options: -h, --help Print help", "Usage: hammer host interface create [OPTIONS] Options: --attached-devices LIST Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces. --attached-to VALUE Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. --bond-options VALUE Space separated options, e.g. miimon=100. Only for bond interfaces. --compute-attributes KEY_VALUE_LIST Compute resource specific attributes --domain VALUE Domain name --domain-id NUMBER Satellite domain ID of interface. Required for primary interfaces on managed hosts. --execution BOOLEAN Should this interface be used for remote execution? --host VALUE Host name --host-id VALUE ID or name of host --identifier VALUE Device identifier, e.g. eth0 or eth1.1 --ip VALUE IPv4 address of interface --ip6 VALUE IPv6 address of interface --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE MAC address of interface. Required for managed interfaces on bare metal. --managed BOOLEAN Should this interface be managed via DHCP and DNS capsule and should it be configured during provisioning? --mode ENUM Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Possible value(s): 'balance-rr', 'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb', 'balance-alb' --mtu NUMBER MTU, this attribute has precedence over the subnet MTU. --name VALUE Interface's DNS name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE Only for BMC interfaces. --primary Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface --provider ENUM Interface provider, e.g. IPMI. Only for BMC interfaces. Possible value(s): 'IPMI', 'Redfish', 'SSH' --provision Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface --subnet VALUE Subnet name --subnet-id NUMBER Satellite subnet ID of IPv4 interface --subnet6-id NUMBER Satellite subnet ID of IPv6 interface --tag VALUE VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. --type ENUM Interface type, e.g. bmc. Default is interface Possible value(s): 'interface', 'bmc', 'bond', 'bridge' --username VALUE Only for BMC interfaces. --virtual BOOLEAN Alias or VLAN device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host interface <delete|destroy> [OPTIONS] Options: --host VALUE Host name --host-id VALUE ID or name of host --id VALUE ID of interface --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host interface <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --host VALUE Host name --host-id VALUE ID or name of host --id VALUE ID or name of interface --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Identifier | x | x | Type | x | x | Mac address | x | x | Ip address | x | x | Dns name | x | x | Subnet | x | x | Domain | x | x | Managed | x | x | Primary | x | x | Provision | x | x | Virtual | x | x | Tag | x | x | Attached to | x | x | Bmc/username | x | x | Bmc/provider | x | x | Bond/mode | x | x | Bond/attached devices | x | x | Bond/bond options | x | x | Execution | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host interface <list|index> [OPTIONS] Options: --domain VALUE Domain name --domain-id VALUE ID or name of domain --fields LIST Show specified fields or predefined field sets only. (See below) --host VALUE Host name --host-id VALUE ID or name of host --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --subnet VALUE Subnet name --subnet-id VALUE ID or name of subnet -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Identifier | x | x | Type | x | x | Mac address | x | x | Ip address | x | x | Dns name | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host interface update [OPTIONS] Options: --attached-devices LIST Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces. --attached-to VALUE Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. --bond-options VALUE Space separated options, e.g. miimon=100. Only for bond interfaces. --compute-attributes KEY_VALUE_LIST Compute resource specific attributes --domain VALUE Domain name --domain-id NUMBER Satellite domain ID of interface. Required for primary interfaces on managed hosts. --execution BOOLEAN Should this interface be used for remote execution? --host VALUE Host name --host-id VALUE ID or name of host --id VALUE ID of interface --identifier VALUE Device identifier, e.g. eth0 or eth1.1 --ip VALUE IPv4 address of interface --ip6 VALUE IPv6 address of interface --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE MAC address of interface. Required for managed interfaces on bare metal. --managed BOOLEAN Should this interface be managed via DHCP and DNS capsule and should it be configured during provisioning? --mode ENUM Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Possible value(s): 'balance-rr', 'active-backup', 'balance-xor', 'broadcast', '802.3ad', 'balance-tlb', 'balance-alb' --mtu NUMBER MTU, this attribute has precedence over the subnet MTU. --name VALUE Interface's DNS name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE Only for BMC interfaces. --primary Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface --provider ENUM Interface provider, e.g. IPMI. Only for BMC interfaces. Possible value(s): 'IPMI', 'Redfish', 'SSH' --provision Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface --subnet VALUE Subnet name --subnet-id NUMBER Satellite subnet ID of IPv4 interface --subnet6-id NUMBER Satellite subnet ID of IPv6 interface --tag VALUE VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. --type ENUM Interface type, e.g. bmc. Default is interface Possible value(s): 'interface', 'bmc', 'bond', 'bridge' --username VALUE Only for BMC interfaces. --virtual BOOLEAN Alias or VLAN device -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --location VALUE Set the current location context for the request --location-id VALUE ID of location --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id VALUE ID of organization --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --thin BOOLEAN Only list ID and name of hosts -h, --help Print help Predefined field sets: -----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------|-----|---------|----- Id | x | x | x Name | x | x | x Operating system | x | x | Host group | x | x | Ip | x | x | Mac | x | x | Global status | x | x | Organization | x | | Location | x | | Additional information | x | | Content view | x | x | Lifecycle environment | x | x | Security | x | | Bugfix | x | | Enhancement | x | | Trace status | x | x | -----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: activation_key string activation_key_id string addon string addons_status Values: mismatched, matched, not_specified ansible_role string applicable_debs string applicable_errata string applicable_errata_issued date applicable_rpms string architecture string autoheal boolean boot_time build Values: true, false build_status Values: built, pending, token_expired, build_failed comment text compute_resource string compute_resource_id integer content_source string content_view string content_view_id integer created_at datetime cve_id integer domain string domain_id integer errata_status Values: security_needed, errata_needed, updated, unknown execution_status Values: ok, error facts string global_status Values: ok, warning, error has_ip string has_mac string hostgroup string hostgroup_fullname string hostgroup_id integer hostgroup_name string hostgroup_title string hypervisor boolean hypervisor_host string id integer image string infrastructure_facet.foreman infrastructure_facet.smart_proxy_id insights_recommendations_count integer installable_errata string installed_at datetime ip string job_invocation.id string job_invocation.result Values: cancelled, failed, pending, success last_checkin datetime last_report datetime lifecycle_environment string lifecycle_environment_id integer location string location_id integer mac string managed Values: true, false model string name string organization string organization_id integer origin string os string os_description string os_id integer os_major string os_minor string os_title string owner string owner_id integer owner_type string params string params_name string parent_hostgroup string puppet_ca string puppet_proxy_id integer puppetmaster string purpose_status Values: mismatched, matched, not_specified realm string realm_id integer registered_at datetime registered_through string release_version string reported.boot_time reported.cores reported.disks_total reported.ram reported.sockets reported.virtual Values: true, false repository string repository_content_label string role text role_status Values: mismatched, matched, not_specified service_level string sla_status Values: mismatched, matched, not_specified smart_proxy string status.applied integer status.enabled Values: true, false status.failed integer status.failed_restarts integer status.interesting Values: true, false status.pending integer status.restarted integer status.skipped integer subnet string subnet.name text subnet6 string subnet6.name text subscription_id string subscription_name string subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor subscription_uuid string trace_status Values: reboot_needed, process_restart_needed, updated upgradable_debs string upgradable_rpms string usage text usage_status Values: mismatched, matched, not_specified user.firstname string user.lastname string user.login string user.mail string usergroup string usergroup.name string uuid string", "Usage: hammer host package [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. list, index List packages installed on the host remove Uninstall packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. upgrade Update packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. upgrade-all Update packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. Options: -h, --help Print help", "Usage: hammer host package install [OPTIONS] Options: --async Do not wait for the task --host VALUE Host name --host-id NUMBER ID of the host --packages LIST List of package names -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host package <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER ID of the host --include-latest-upgradable BOOLEAN Also include the latest upgradable package version for each host package --order VALUE Sort field and order, eg. 'id DESC' --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --status VALUE Return only packages of a particular status (upgradable or up-to-date) -h, --help Print help Predefined field sets: -------|-----|-------- FIELDS | ALL | DEFAULT -------|-----|-------- Nvra | x | x -------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: arch string epoch string name string nvra string nvrea string release string version string", "Usage: hammer host package remove [OPTIONS] Options: --async Do not wait for the task --host VALUE Host name --host-id NUMBER ID of the host --packages LIST List of package names -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host package upgrade [OPTIONS] Options: --async Do not wait for the task --host VALUE Host name --host-id NUMBER ID of the host --packages LIST List of packages names -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host package upgrade-all [OPTIONS] Options: --async Do not wait for the task --host VALUE Host name --host-id NUMBER ID of the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host package-group [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. remove Uninstall packages remotely using katello-agent. NOTE: Katello-agent is deprecated and will be removed in a future release. Consider using remote execution instead. Options: -h, --help Print help", "Usage: hammer host package-group install [OPTIONS] Options: --async Do not wait for the task --groups LIST List of package group names (Deprecated) --host VALUE Host name --host-id NUMBER ID of the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host package-group remove [OPTIONS] Options: --async Do not wait for the task --groups LIST List of package group names (Deprecated) --host VALUE Host name --host-id NUMBER ID of the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host policies-enc [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE The identifier of the host --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------------|-----|-------- FIELDS | ALL | DEFAULT ------------------------|-----|-------- Id | x | x Profile id | x | x Content path | x | x Content download path | x | x Tailoring path | x | x Tailoring download path | x | x Day of month | x | x Hour | x | x Minute | x | x Month | x | x Week | x | x ------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host reboot [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host rebuild-config [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --only LIST Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host reports [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Host id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Host | x | x | Last report | x | x | Origin | x | x | Applied | x | x | Restarted | x | x | Failed | x | x | Restart failures | x | x | Skipped | x | x | Pending | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer", "Usage: hammer host reset [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --host VALUE Host name --host-id NUMBER --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host start [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host status [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --type ENUM Status type, can be one of Global Configuration Build Possible value(s): 'HostStatus::Global', 'configuration', 'build' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host stop [OPTIONS] Options: --force Force turning off a host --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Host name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: attach Add a subscription to a host auto-attach Trigger an auto-attach of subscriptions content-override Override product content defaults product-content List associated products register Register a host with subscription and information remove unregister Unregister the host as a subscription consumer Options: -h, --help Print help", "Usage: hammer host subscription attach [OPTIONS] Options: --host VALUE Host name --host-id NUMBER Id of the host --quantity VALUE Quantity of this subscriptions to add. Defaults to 1 --subscription-id VALUE ID of subscription -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription auto-attach [OPTIONS] Options: --host VALUE Host name --host-id NUMBER Id of the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription content-override [OPTIONS] Options: --content-label VALUE Label of the content --host VALUE Host name --host-id VALUE Id of the content host --override-name VALUE Override parameter key or name. To enable or disable a repo select 'enabled'. Default value: enabled Default: \"enabled\" --remove Remove a content override --value VALUE Override value. Note for repo enablement you can use a boolean value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription product-content [OPTIONS] Options: --content-access-mode-all BOOLEAN Get all content available, not just that provided by subscriptions --content-access-mode-env BOOLEAN Limit content to just that available in the host's content view version --fields LIST Show specified fields or predefined field sets only. (See below) --host VALUE Host name --host-id VALUE Id of the host -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Type | x | x | Url | x | x | Gpg key | x | x | Label | x | x | Default enabled? | x | x | Override | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription register [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content View ID --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --hypervisor-guest-uuids LIST UUIDs of the virtual guests from the host's hypervisor --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Lifecycle Environment ID --name VALUE Name of the host --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --release-version VALUE Release version of the content host --service-level VALUE A service level for auto-healing process, e.g. SELF-SUPPORT --uuid VALUE UUID to use for registered host, random uuid is generated if not provided -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription remove [OPTIONS] Options: --host VALUE Host name --host-id NUMBER Id of the host --quantity VALUE Remove the first instance of a subscription with matching id and quantity --subscription-id VALUE ID of subscription -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host subscription unregister [OPTIONS] Options: --host VALUE Host name --host-id NUMBER Id of the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host traces [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: list List services that need restarting on the host resolve Resolve traces Options: -h, --help Print help", "Usage: hammer host traces list [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --host VALUE Host name --host-id NUMBER ID of the host -h, --help Print help Predefined field sets: ------------|-----|-------- FIELDS | ALL | DEFAULT ------------|-----|-------- Trace id | x | x Application | x | x Helper | x | x Type | x | x ------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host traces resolve [OPTIONS] Options: --async Do not wait for the task --host VALUE Host name --host-id NUMBER ID of the host --trace-ids LIST Array of Trace IDs -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host update [OPTIONS] Options: --ansible-role-ids LIST IDs of associated ansible roles --ansible-roles LIST --architecture VALUE Architecture name --architecture-id NUMBER Required if host is managed and value is not inherited from host group --ask-root-password BOOLEAN --autoheal BOOLEAN Sets whether the Host will autoheal subscriptions upon checkin --build BOOLEAN --comment VALUE Additional information about this host --compute-attributes KEY_VALUE_LIST Compute resource attributes --compute-profile VALUE Compute profile name --compute-profile-id NUMBER --compute-resource VALUE Compute resource name --compute-resource-id NUMBER Nil means host is bare metal --content-source VALUE Content Source name --content-source-id NUMBER --content-view VALUE Name to search by --content-view-id NUMBER --domain VALUE Domain name --domain-id NUMBER Required if host is managed and value is not inherited from host group --enabled BOOLEAN Include this host within Satellite reporting --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --hypervisor-guest-uuids LIST List of hypervisor guest uuids --id VALUE --image VALUE Name to search by --image-id NUMBER --installed-products-attributes SCHEMA List of products installed on the host --interface KEY_VALUE_LIST Interface parameters Can be specified multiple times. --ip VALUE Not required if using a subnet with DHCP Capsule --kickstart-repository VALUE Kickstart repository name --kickstart-repository-id NUMBER Repository Id associated with the kickstart repo used for provisioning --lifecycle-environment VALUE Name to search by --lifecycle-environment-id NUMBER --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mac VALUE Required for managed host that is bare metal, not required if it's a virtual machine --managed BOOLEAN True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not --medium VALUE Medium name --medium-id VALUE Required if not imaged based provisioning and host is managed and value is not inherited from host group --model VALUE Model name --model-id NUMBER --name VALUE --new-location VALUE Use to update associated location --new-location-id NUMBER Use to update associated location --new-location-title VALUE Use to update associated location --new-name VALUE --new-organization VALUE Use to update associated organization --new-organization-id NUMBER Use to update associated organization --new-organization-title VALUE Use to update associated organization --openscap-proxy-id NUMBER ID of OpenSCAP Capsule --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Required if host is managed and value is not inherited from host group --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --overwrite BOOLEAN --owner VALUE Login of the owner --owner-id VALUE ID of the owner --owner-type ENUM Host's owner type Possible value(s): 'User', 'Usergroup' --parameters KEY_VALUE_LIST Replaces with new host parameters --partition-table VALUE Partition table name --partition-table-id NUMBER Required if host is managed and custom partition has not been defined --product VALUE Name to search by --product-id NUMBER Product id as listed from a host's installed products, this is not the same product id as the products api returns --progress-report-id VALUE UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks --provision-method ENUM The method used to provision the host. Possible value(s): 'build', 'image', 'bootdisk' --puppet-ca-proxy-id NUMBER Puppet CA Capsule ID --puppet-proxy-id NUMBER Puppet Capsule ID --purpose-addons LIST Sets the system add-ons --purpose-role VALUE Sets the system purpose usage --purpose-usage VALUE Sets the system purpose usage --pxe-loader ENUM DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --realm VALUE Name to search by --realm-id NUMBER --release-version VALUE Release version for this Host to use (7Server, 7.1, etc) --root-password VALUE Required if host is managed and value is not inherited from host group or default password in settings --service-level VALUE Service level to be used for autoheal --subnet VALUE Subnet name --subnet-id NUMBER Required if host is managed and value is not inherited from host group --typed-parameters SCHEMA Replaces with new host parameters (with type support) --volume KEY_VALUE_LIST Volume parameters Can be specified multiple times. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --typed-parameters \"name=<string>\\,value=<string>\\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\\,hidden_value=[true|false|1|0], ... \" --installed-products-attributes \"product_id=<string>\\,product_name=<string>\\,arch=<string>\\,version=<string>, ... \" Available keys for --interface: mac ip type Possible values: interface, bmc, bond, bridge name subnet_id domain_id identifier managed true/false primary true/false, each managed hosts needs to have one primary interface. provision true/false virtual true/false For virtual=true: tag VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. attached_to Identifier of the interface to which this interface belongs, e.g. eth1. For type=bond: mode Possible values: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb attached_devices Identifiers of slave interfaces, e.g. [eth1,eth2] bond_options For type=bmc: provider always IPMI username password Provider specific options: NOTE: Bold attributes are required. EC2: --volume: --interface: --compute-attributes: availability_zone flavor_id groups security_group_ids managed_ip GCE: --volume: size_gb Volume size in GB, integer value --interface: --compute-attributes: machine_type network associate_external_ip Libvirt: --volume: pool_name One of available storage pools capacity String value, e.g. 10G allocation Initial allocation, e.g. 0G format_type Possible values: raw, qcow2 --interface: compute_type Possible values: bridge, network compute_bridge Name of interface according to type compute_model Possible values: virtio, rtl8139, ne2k_pci, pcnet, e1000 compute_network Libvirt instance network, e.g. default --compute-attributes: cpus Number of CPUs memory String, amount of memory, value in bytes cpu_mode Possible values: default, host-model, host-passthrough start Boolean (expressed as 0 or 1), whether to start the machine or not OpenStack: --volume: --interface: --compute-attributes: availability_zone boot_from_volume flavor_ref image_ref tenant_id security_groups network oVirt: --volume: size_gb Volume size in GB, integer value storage_domain ID or name of storage domain bootable Boolean, set 1 for bootable, only one volume can be bootable preallocate Boolean, set 1 to preallocate wipe_after_delete Boolean, set 1 to wipe disk after delete interface Disk interface name, must be ide, virto or virto_scsi --interface: compute_name Compute name, e.g. eth0 compute_network Select one of available networks for a cluster, must be an ID or a name compute_interface Interface type compute_vnic_profile Vnic Profile --compute-attributes: cluster ID or name of cluster to use template Hardware profile to use cores Integer value, number of cores sockets Integer value, number of sockets memory Amount of memory, integer value in bytes ha Boolean, set 1 to high availability display_type Possible values: VNC, SPICE keyboard_layout Possible values: ar, de-ch, es, fo, fr-ca, hu, ja, mk, no, pt-br, sv, da, en-gb, et, fr, fr-ch, is, lt, nl, pl, ru, th, de, en-us, fi, fr-be, hr, it, lv, nl-be, pt, sl, tr. Not usable if display type is SPICE. start Boolean, set 1 to start the vm Rackspace: --volume: --interface: --compute-attributes: flavor_id VMware: --volume: name storage_pod Storage Pod ID from VMware datastore Datastore ID from VMware mode persistent/independent_persistent/independent_nonpersistent size_gb Integer number, volume size in GB thin true/false eager_zero true/false controller_key Associated SCSI controller key --interface: compute_type Type of the network adapter, for example one of: VirtualVmxnet3 VirtualE1000 See documentation center for your version of vSphere to find more details about available adapter types: https://www.vmware.com/support/pubs/ compute_network Network ID or Network Name from VMware --compute-attributes: cluster Cluster ID from VMware corespersocket Number of cores per socket (applicable to hardware versions < 10 only) cpus CPU count memory_mb Integer number, amount of memory in MB path Path to folder resource_pool Resource Pool ID from VMware firmware automatic/bios/efi guest_id Guest OS ID form VMware hardware_version Hardware version ID from VMware memoryHotAddEnabled Must be a 1 or 0, lets you add memory resources while the machine is on cpuHotAddEnabled Must be a 1 or 0, lets you add CPU resources while the machine is on add_cdrom Must be a 1 or 0, Add a CD-ROM drive to the virtual machine annotation Annotation Notes scsi_controllers List with SCSI controllers definitions type - ID of the controller from VMware key - Key of the controller (e.g. 1000) start Must be a 1 or 0, whether to start the machine or not AzureRM: --volume: disk_size_gb Volume Size in GB (integer value) data_disk_caching Data Disk Caching (None, ReadOnly, ReadWrite) --interface: compute_network Select one of available Azure Subnets, must be an ID compute_public_ip Public IP (None, Static, Dynamic) compute_private_ip Static Private IP (expressed as true or false) --compute-attributes: resource_group Existing Azure Resource Group of user vm_size VM Size, eg. Standard_A0 etc. username The Admin username password The Admin password platform OS type eg. Linux ssh_key_data SSH key for passwordless authentication os_disk_caching OS disk caching premium_os_disk Premium OS Disk, Boolean as 0 or 1 script_command Custom Script Command script_uris Comma seperated file URIs", "Usage: hammer host-collection [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-host Add host to the host collection copy Copy a host collection create Create a host collection delete, destroy Destroy a host collection erratum Manipulate errata for a host collection hosts List all hosts info, show Show a host collection list, index List host collections package Manipulate packages for a host collection package-group Manipulate package-groups for a host collection remove-host Remove hosts from the host collection update Update a host collection Options: -h, --help Print help", "Usage: hammer host-collection add-host [OPTIONS] Options: --host-ids LIST Array of host ids --hosts LIST --id NUMBER Id of the host collection --name VALUE Host collection name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection copy [OPTIONS] Options: --id NUMBER ID of the host collection --name VALUE New host collection name --new-name VALUE New host collection name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection create [OPTIONS] Options: --description VALUE --host-ids LIST List of host ids to replace the hosts in host collection --hosts LIST --max-hosts NUMBER Maximum number of hosts in the host collection --name VALUE Host Collection name --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection <delete|destroy> [OPTIONS] Options: --id NUMBER Id of the host collection --name VALUE Host collection name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection erratum [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install errata on content hosts contained within a host collection Options: -h, --help Print help", "Usage: hammer host-collection erratum install [OPTIONS] Options: --errata LIST List of Errata to install --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection hosts [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --id VALUE Host Collection ID --include ENUM Array of extra information types to include Possible value(s): 'parameters', 'all_parameters' --location VALUE Set the current location context for the request --location-id VALUE ID of location --location-title VALUE Set the current location context for the request --name VALUE Host Collection Name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Organization name to search by --organization-id VALUE ID of organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --thin BOOLEAN Only list ID and name of hosts -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Security | x | | Bugfix | x | | Enhancement | x | | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: activation_key string activation_key_id string addon string addons_status Values: mismatched, matched, not_specified ansible_role string applicable_debs string applicable_errata string applicable_errata_issued date applicable_rpms string architecture string autoheal boolean boot_time build Values: true, false build_status Values: built, pending, token_expired, build_failed comment text compute_resource string compute_resource_id integer content_source string content_view string content_view_id integer created_at datetime cve_id integer domain string domain_id integer errata_status Values: security_needed, errata_needed, updated, unknown execution_status Values: ok, error facts string global_status Values: ok, warning, error has_ip string has_mac string hostgroup string hostgroup_fullname string hostgroup_id integer hostgroup_name string hostgroup_title string hypervisor boolean hypervisor_host string id integer image string infrastructure_facet.foreman infrastructure_facet.smart_proxy_id insights_recommendations_count integer installable_errata string installed_at datetime ip string job_invocation.id string job_invocation.result Values: cancelled, failed, pending, success last_checkin datetime last_report datetime lifecycle_environment string lifecycle_environment_id integer location string location_id integer mac string managed Values: true, false model string name string organization string organization_id integer origin string os string os_description string os_id integer os_major string os_minor string os_title string owner string owner_id integer owner_type string params string params_name string parent_hostgroup string puppet_ca string puppet_proxy_id integer puppetmaster string purpose_status Values: mismatched, matched, not_specified realm string realm_id integer registered_at datetime registered_through string release_version string reported.boot_time reported.cores reported.disks_total reported.ram reported.sockets reported.virtual Values: true, false repository string repository_content_label string role text role_status Values: mismatched, matched, not_specified service_level string sla_status Values: mismatched, matched, not_specified smart_proxy string status.applied integer status.enabled Values: true, false status.failed integer status.failed_restarts integer status.interesting Values: true, false status.pending integer status.restarted integer status.skipped integer subnet string subnet.name text subnet6 string subnet6.name text subscription_id string subscription_name string subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor subscription_uuid string trace_status Values: reboot_needed, process_restart_needed, updated upgradable_debs string upgradable_rpms string usage text usage_status Values: mismatched, matched, not_specified user.firstname string user.lastname string user.login string user.mail string usergroup string usergroup.name string uuid string", "Usage: hammer host-collection <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the host collection --name VALUE Host collection name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Limit | x | x | Description | x | x | Total hosts | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection <list|index> [OPTIONS] Options: --activation-key VALUE Activation key name to search by --activation-key-id VALUE Activation key identifier --available-for VALUE Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported. --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Filter products by host id --name VALUE Host collection name to filter by --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Limit | x | x | Description | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: host string name string organization_id integer", "Usage: hammer host-collection package [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install packages on content hosts contained within a host collection remove Remove packages on content hosts contained within a host collection update Update packages on content hosts contained within a host collection Options: -h, --help Print help", "Usage: hammer host-collection package install [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages LIST Comma-separated list of packages to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection package remove [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages LIST Comma-separated list of packages to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection package update [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages LIST Comma-separated list of packages to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection package-group [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: install Install package-groups on content hosts contained within a host collection remove Remove package-groups on content hosts contained within a host collection update Update package-groups on content hosts contained within a host collection Options: -h, --help Print help", "Usage: hammer host-collection package-group install [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --package-groups LIST Comma-separated list of package-groups to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection package-group remove [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --package-groups LIST Comma-separated list of package-groups to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection package-group update [OPTIONS] Options: --id VALUE Host Collection ID --name VALUE Host Collection Name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --package-groups LIST Comma-separated list of package-groups to install -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection remove-host [OPTIONS] Options: --host-ids LIST Array of host ids --hosts LIST --id NUMBER Id of the host collection --name VALUE Host collection name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-collection update [OPTIONS] Options: --description VALUE --host-ids LIST List of host ids to replace the hosts in host collection --hosts LIST --id NUMBER Id of the host collection --max-hosts NUMBER Maximum number of hosts in the host collection --name VALUE Host Collection name --new-name VALUE Host Collection name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --unlimited-hosts Set hosts max to unlimited -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer host-registration [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: generate-command Generate global registration command Options: -h, --help Print help", "Usage: hammer host-registration generate-command [OPTIONS] Options: --activation-key VALUE Activation key for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. For multiple keys use `activation_keys` param instead. --activation-keys LIST Activation keys for subscription-manager client, required for CentOS and Red Hat Enterprise Linux. Required only if host group has no activation keys. --force BOOLEAN Clear any previous registration and run subscription-manager with -force. --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER ID of the Host group to register the host in --hostgroup-title VALUE Hostgroup title --ignore-subman-errors BOOLEAN Ignore subscription-manager errors for `subscription-manager register` command --insecure BOOLEAN Enable insecure argument for the initial curl --jwt-expiration NUMBER Expiration of the authorization token (in hours) --lifecycle-environment VALUE Name to search by --lifecycle-environment-id NUMBER Lifecycle environment for the host. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of the Operating System to register the host in. Operating system must have a `host_init_config` template assigned --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --packages VALUE Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2` --remote-execution-interface VALUE Identifier of the Host interface for Remote execution --repo VALUE Repository URL / details, for example for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat OS family: 'yum.theforeman.org/client/latest/el8/x86_64/' --repo-gpg-key-url VALUE URL of the GPG key for the repository --setup-insights BOOLEAN Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems --setup-remote-execution BOOLEAN Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host --smart-proxy VALUE Name to search by --smart-proxy-id NUMBER ID of the Capsule. This Capsule must have enabled both the 'Templates' and 'Registration' features --update-packages BOOLEAN Update all packages on the host -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: ansible-roles Manage Ansible roles on a hostgroup create Create a host group delete, destroy Delete a host group delete-parameter Delete parameter for a hostgroup info, show Show a host group list, index List all host groups rebuild-config Rebuild orchestration config set-parameter Create or update parameter for a hostgroup update Update a host group Options: -h, --help Print help", "Usage: hammer hostgroup ansible-roles [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: assign Assigns Ansible roles to a hostgroup list, index List all Ansible roles for a hostgroup play Runs all Ansible roles on a hostgroup Options: -h, --help Print help", "Usage: hammer hostgroup ansible-roles assign [OPTIONS] Options: --ansible-role-ids LIST Ansible roles to assign to a hostgroup --ansible-roles LIST --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Hostgroup title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup ansible-roles <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Hostgroup title -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Imported at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup ansible-roles play [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Hostgroup title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup create [OPTIONS] Options: --ansible-role-ids LIST IDs of associated ansible roles --ansible-roles LIST --architecture VALUE Architecture name --architecture-id NUMBER Architecture ID --ask-root-password BOOLEAN --compute-profile VALUE Compute profile name --compute-profile-id NUMBER Compute profile ID --compute-resource VALUE Compute resource name --compute-resource-id NUMBER Compute resource ID --content-source VALUE Content Source name --content-source-id NUMBER Content source ID --content-view VALUE Name to search by --content-view-id NUMBER Content view ID --description VALUE Host group description --domain VALUE Domain name --domain-id NUMBER Domain ID --group-parameters-attributes SCHEMA Array of parameters --kickstart-repository VALUE Kickstart repository name --kickstart-repository-id NUMBER Kickstart repository ID --lifecycle-environment VALUE Name to search by --lifecycle-environment-id NUMBER Lifecycle environment ID --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --medium VALUE Medium name --medium-id NUMBER Media ID --name VALUE Name of the host group --openscap-proxy-id NUMBER ID of OpenSCAP Capsule --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Operating system ID --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --parent VALUE Name of parent hostgroup --parent-id NUMBER Parent ID of the host group --parent-title VALUE Title of parent hostgroup --partition-table VALUE Partition table name --partition-table-id NUMBER Partition table ID --puppet-ca-proxy-id NUMBER Puppet CA Capsule ID --puppet-proxy-id NUMBER Puppet Capsule ID --pxe-loader ENUM DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --query-organization VALUE Organization name to search by --query-organization-id VALUE Organization ID to search by --query-organization-label VALUE Organization label to search by --realm VALUE Name to search by --realm-id NUMBER Realm ID --root-password VALUE Root password --subnet VALUE Subnet name --subnet-id NUMBER Subnet ID --subnet6 VALUE Subnet IPv6 name --subnet6-id NUMBER Subnet IPv6 ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --group-parameters-attributes \"name=<string>\\,value=<string>\\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\\,hidden_value=[true|false|1|0], ... \"", "Usage: hammer hostgroup <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Hostgroup title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup delete-parameter [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --name VALUE Parameter name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values --title VALUE Hostgroup title -h, --help Print help Predefined field sets: ----------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Title | x | x | x Model | x | x | Description | x | x | Parent | x | x | Compute profile | x | x | Compute resource | x | x | Network/subnet ipv4 | x | x | Network/subnet ipv6 | x | x | Network/realm | x | x | Network/domain | x | x | Operating system/architecture | x | x | Operating system/operating system | x | x | Operating system/medium | x | x | Operating system/partition table | x | x | Operating system/pxe loader | x | x | Parameters/ | x | x | Locations/ | x | x | Organizations/ | x | x | Openscap proxy | x | x | Content view/id | x | x | Content view/name | x | x | Lifecycle environment/id | x | x | Lifecycle environment/name | x | x | Content source/id | x | x | Content source/name | x | x | Kickstart repository/id | x | x | Kickstart repository/name | x | x | ----------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Title | x | x | x Operating system | x | x | Model | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: architecture string host string id integer label string location string location_id integer medium string name string organization string organization_id integer os string os_description string os_id integer os_major string os_minor string os_title string oval_policy_id string params string template string title string", "Usage: hammer hostgroup rebuild-config [OPTIONS] Options: --children-hosts BOOLEAN Operate on child hostgroup hosts --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Hostgroup name --only LIST Limit rebuild steps, valid steps are DHCP, DNS, TFTP, Content_Host_Status, Refresh_Content_Host_Status --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Hostgroup title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer hostgroup update [OPTIONS] Options: --ansible-role-ids LIST IDs of associated ansible roles --ansible-roles LIST --architecture VALUE Architecture name --architecture-id NUMBER Architecture ID --ask-root-password BOOLEAN --compute-profile VALUE Compute profile name --compute-profile-id NUMBER Compute profile ID --compute-resource VALUE Compute resource name --compute-resource-id NUMBER Compute resource ID --content-source VALUE Content Source name --content-source-id NUMBER Content source ID --content-view VALUE Name to search by --content-view-id NUMBER Content view ID --description VALUE Host group description --domain VALUE Domain name --domain-id NUMBER Domain ID --group-parameters-attributes SCHEMA Array of parameters --id VALUE --kickstart-repository VALUE Kickstart repository name --kickstart-repository-id NUMBER Kickstart repository ID --lifecycle-environment VALUE Name to search by --lifecycle-environment-id NUMBER Lifecycle environment ID --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --medium VALUE Medium name --medium-id NUMBER Media ID --name VALUE Name of the host group --new-name VALUE Name of the host group --openscap-proxy-id NUMBER ID of OpenSCAP Capsule --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER Operating system ID --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --parent VALUE Name of parent hostgroup --parent-id NUMBER Parent ID of the host group --parent-title VALUE Title of parent hostgroup --partition-table VALUE Partition table name --partition-table-id NUMBER Partition table ID --puppet-ca-proxy-id NUMBER Puppet CA Capsule ID --puppet-proxy-id NUMBER Puppet Capsule ID --pxe-loader ENUM DHCP filename option (Grub2/PXELinux by default) Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 BIOS', 'Grub2 ELF', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI' --query-organization VALUE Organization name to search by --query-organization-id VALUE Organization ID to search by --query-organization-label VALUE Organization label to search by --realm VALUE Name to search by --realm-id NUMBER Realm ID --root-password VALUE Root password --subnet VALUE Subnet name --subnet-id NUMBER Subnet ID --subnet6 VALUE Subnet IPv6 name --subnet6-id NUMBER Subnet IPv6 ID --title VALUE Hostgroup title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --group-parameters-attributes \"name=<string>\\,value=<string>\\,parameter_type=[string|boolean|integer|real|array|hash|yaml|json]\\,hidden_value=[true|false|1|0], ... \"", "Usage: hammer http-proxy [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an HTTP Proxy delete, destroy Delete an HTTP Proxy info, show Show an HTTP Proxy list, index List of HTTP Proxies update Update an HTTP Proxy Options: -h, --help Print help", "Usage: hammer http-proxy create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The HTTP Proxy name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --password VALUE Password used to authenticate with the HTTP Proxy --url VALUE URL of the HTTP Proxy --username VALUE Username used to authenticate with the HTTP Proxy -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer http-proxy <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer http-proxy <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Identifier of the HTTP Proxy --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Username | x | x | Url | x | x | Locations/ | x | x | Organizations/ | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer http-proxy <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer url string", "Usage: hammer http-proxy update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The HTTP Proxy name --new-name VALUE The HTTP Proxy name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --password VALUE Password used to authenticate with the HTTP Proxy --url VALUE URL of the HTTP Proxy --username VALUE Username used to authenticate with the HTTP Proxy -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer import-templates [OPTIONS] Options: --associate ENUM Associate to OS's, Locations & Organizations. Options are: always, new or never. Possible value(s): 'always', 'new', 'never' --branch VALUE Branch in Git repo. --dirname VALUE The directory within Git repo containing the templates --filter VALUE Export templates with names matching this regex (case-insensitive; snippets are not filtered). --force BOOLEAN Update templates that are locked --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --lock ENUM Lock imported templates Possible value(s): 'lock', 'keep_lock_new', 'keep', 'unlock', 'true', 'false', '0', '1' --negate BOOLEAN Negate the prefix (for purging). --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --prefix VALUE The string all imported templates should begin with. --repo VALUE Override the default repo from settings. --verbose BOOLEAN Show template diff in response -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: cancel Cancel the job create Create a job invocation info, show Show job invocation list, index List job invocations output View the output for a host rerun Rerun the job Options: -h, --help Print help", "Usage: hammer job-invocation cancel [OPTIONS] Options: --force BOOLEAN --id VALUE --location-id NUMBER Set the current location context for the request --organization-id NUMBER Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation create [OPTIONS] Options: --async Do not wait for the task --bookmark VALUE Name to search by --bookmark-id NUMBER --concurrency-level NUMBER Run at most N tasks at a time --cron-line VALUE Create a recurring execution Cron line format 'a b c d e', where: a. is minute (range: 0-59) b. is hour (range: 0-23) c. is day of month (range: 1-31) d. is month (range: 1-12) e. is day of week (range: 0-6) --description-format VALUE Override the description format from the template for this invocation only --dynamic Dynamic search queries are evaluated at run time --effective-user VALUE What user should be used to run the script (using sudo-like mechanisms). Defaults to a template parameter or global setting. --effective-user-password VALUE Set password for effective user (using sudo-like mechanisms) --end-time DATETIME Perform no more executions after this time, used with --cron-line --execution-timeout-interval NUMBER Override the timeout interval from the template for this invocation only --feature VALUE Remote execution feature label that should be triggered, job template assigned to this feature will be used --input-files KEY_VALUE_LIST Read input values from files Comma-separated list of key=file, where file is a path to a text file to be read --inputs KEY_VALUE_LIST Specify inputs from command line --job-template VALUE Name to search by --job-template-id VALUE The job template to use, parameter is required unless feature was specified --key-passphrase VALUE Set SSH key passphrase --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --max-iteration NUMBER Repeat a maximum of N times --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE Set SSH password --purpose VALUE Designation of a special purpose --randomized-ordering BOOLEAN Execute the jobs on hosts in randomized order --search-query VALUE --start-at DATETIME Schedule the execution for a later time --start-before DATETIME Execution should be cancelled if it cannot be started before --start-at --tags VALUE A comma separated list of tags to use for Ansible run --tags-flag ENUM IncludeExclude tags for Ansible run Possible value(s): 'include', 'exclude' --time-span NUMBER Distribute tasks over N seconds -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location-id NUMBER Set the current location context for the request --organization-id NUMBER Set the current organization context for the request --show-host-status Show job status for the hosts --show-inputs Show the complete input of the job -h, --help Print help Predefined field sets: --------------------|-----|-------- FIELDS | ALL | DEFAULT --------------------|-----|-------- Id | x | x Description | x | x Status | x | x Success | x | x Failed | x | x Pending | x | x Missing | x | x Total | x | x Start | x | x Randomized ordering | x | x Inputs | x | x Job category | x | x Mode | x | x Cron line | x | x Recurring logic id | x | x Hosts | x | x --------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------------|-----|-------- FIELDS | ALL | DEFAULT --------------------|-----|-------- Id | x | x Description | x | x Status | x | x Success | x | x Failed | x | x Pending | x | x Total | x | x Start | x | x Randomized ordering | x | x Inputs | x | x --------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation output [OPTIONS] Options: --async Do not wait for job to complete, shows current output only --host VALUE Host name --host-id VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-invocation rerun [OPTIONS] Options: --failed-only BOOLEAN --id VALUE --location-id NUMBER Set the current location context for the request --organization-id NUMBER Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a job template delete, destroy Delete a job template dump View job template content export Export a template including all metadata import Import a job template from ERB info, show Show job template details list, index List job templates update Update a job template Options: -h, --help Print help", "Usage: hammer job-template create [OPTIONS] Options: --audit-comment VALUE --current-user BOOLEAN Whether the current user login should be used as the effective user --description VALUE --description-format VALUE This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}. --file FILE Path to a file that contains the template --job-category VALUE Job category --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE Template name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --overridable BOOLEAN Whether it should be allowed to override the effective user from the invocation form. --provider-type ENUM Provider type Possible value(s): 'SSH', 'Ansible' --snippet BOOLEAN --value VALUE What user should be used to run the script (using sudo-like mechanisms) -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template dump [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template export [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template import [OPTIONS] Options: --file FILE Path to a file that contains the template - must include ERB metadata --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --overwrite BOOLEAN Overwrite template if it already exists -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Job category | x | x | Provider | x | x | Type | x | x | Description | x | x | Inputs | x | x | Locations/ | x | x | Organizations/ | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Job category | x | x | Provider | x | x | Type | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer job-template update [OPTIONS] Options: --audit-comment VALUE --current-user BOOLEAN Whether the current user login should be used as the effective user --description VALUE --description-format VALUE This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}. --file FILE Path to a file that contains the template --id VALUE --job-category VALUE Job category --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE Template name --new-name VALUE Template name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --overridable BOOLEAN Whether it should be allowed to override the effective user from the invocation form. --provider-type ENUM Provider type Possible value(s): 'SSH', 'Ansible' --snippet BOOLEAN --value VALUE What user should be used to run the script (using sudo-like mechanisms) -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer lifecycle-environment [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an environment delete, destroy Destroy an environment info, show Show an environment list, index List environments in an organization paths List environment paths update Update an environment Options: -h, --help Print help", "Usage: hammer lifecycle-environment create [OPTIONS] Options: --description VALUE Description of the environment --label VALUE Label of the environment --name VALUE Name of the environment --organization VALUE Organization name to search by --organization-id NUMBER Name of organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --prior VALUE Name of the prior environment --prior-id NUMBER ID of an environment that is prior to the new environment in the chain. It has to be either the ID of Library or the ID of an environment at the end of a chain. --registry-name-pattern VALUE Pattern for container image names --registry-unauthenticated-pull BOOLEAN Allow unauthenticed pull of container images -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer lifecycle-environment <delete|destroy> [OPTIONS] Options: --id NUMBER ID of the environment --name VALUE Lifecycle environment name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer lifecycle-environment <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER ID of the environment --name VALUE Lifecycle environment name to search by --organization VALUE Organization name to search by --organization-id NUMBER ID of the organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: ----------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Label | x | x | Description | x | x | Organization | x | x | Library | x | x | Prior lifecycle environment | x | x | Unauthenticated pull | x | x | Registry name pattern | x | x | ----------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer lifecycle-environment <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --label VALUE Filter only environments containing this label --library ENUM Set true if you want to see only library environments Possible value(s): 'true', 'false' --name VALUE Filter only environments containing this name --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Prior | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: id integer label string name string organization_id integer", "Usage: hammer lifecycle-environment paths [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --permission-type VALUE The associated permission type. One of (readable | promotable) Default: readable -h, --help Print help Predefined field sets: ---------------|-----|-------- FIELDS | ALL | DEFAULT ---------------|-----|-------- Lifecycle path | x | x ---------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer lifecycle-environment update [OPTIONS] Options: --async BOOLEAN Do not wait for the update action to finish. Default: true --description VALUE Description of the environment --id NUMBER ID of the environment --name VALUE Lifecycle environment name to search by --new-name VALUE New name to be given to the environment --organization VALUE Organization name to search by --organization-id NUMBER Name of the organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --registry-name-pattern VALUE Pattern for container image names --registry-unauthenticated-pull BOOLEAN Allow unauthenticed pull of container images -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-compute-resource Associate a compute resource add-domain Associate a domain add-hostgroup Associate a hostgroup add-medium Associate a medium add-organization Associate an organization add-provisioning-template Associate provisioning templates add-smart-proxy Associate a smart proxy add-subnet Associate a subnet add-user Associate an user create Create a location delete, destroy Delete a location delete-parameter Delete parameter for a location info, show Show a location list, index List all locations remove-compute-resource Disassociate a compute resource remove-domain Disassociate a domain remove-hostgroup Disassociate a hostgroup remove-medium Disassociate a medium remove-organization Disassociate an organization remove-provisioning-template Disassociate provisioning templates remove-smart-proxy Disassociate a smart proxy remove-subnet Disassociate a subnet remove-user Disassociate an user set-parameter Create or update parameter for a location update Update a location Options: -h, --help Print help", "Usage: hammer location add-compute-resource [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id NUMBER --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-domain [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-hostgroup [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-medium [OPTIONS] Options: --id VALUE --medium VALUE Medium name --medium-id NUMBER --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-organization [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Organization ID --organization-title VALUE Set the current organization context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-provisioning-template [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated --provisioning-templates LIST List of provisioning template names --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-smart-proxy [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --smart-proxy VALUE Name to search by --smart-proxy-id NUMBER --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-subnet [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --subnet VALUE Subnet name --subnet-id NUMBER --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location add-user [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location create [OPTIONS] Options: --compute-resource-ids LIST Compute resource IDs --compute-resources LIST --description VALUE --domain-ids LIST Domain IDs --domains LIST --environment-ids LIST Environment IDs --hostgroup-ids LIST Host group IDs --hostgroup-titles LIST --hostgroups LIST --ignore-types LIST List of resources types that will be automatically associated --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --media LIST --medium-ids LIST Medium IDs --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Associated organization IDs --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --parent-id NUMBER Parent ID --partition-table-ids LIST Partition template IDs --partition-tables LIST --provisioning-template-ids LIST Provisioning template IDs --provisioning-templates LIST --realm-ids LIST Realm IDs --realms LIST --smart-proxies LIST --smart-proxy-ids LIST Capsule IDs --subnet-ids LIST Subnet IDs --subnets LIST --user-ids LIST User IDs --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location <delete|destroy> [OPTIONS] Options: --id VALUE Location numeric id to search by --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location delete-parameter [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER --location-title VALUE Set the current location context for the request --name VALUE Parameter name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Location numeric id to search by --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values --title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Title | x | x | x Name | x | x | x Description | x | x | Parent | x | x | Users/ | x | x | Smart proxies/ | x | x | Subnets/ | x | x | Compute resources/ | x | x | Installation media/ | x | x | Templates/ | x | x | Partition tables/ | x | x | Domains/ | x | x | Realms/ | x | x | Hostgroups/ | x | x | Parameters/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Title | x | x | x Name | x | x | x Description | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: description text id integer location_id integer name string title string", "Usage: hammer location remove-compute-resource [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id NUMBER --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-domain [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-hostgroup [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-medium [OPTIONS] Options: --id VALUE --medium VALUE Medium name --medium-id NUMBER --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-organization [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Organization ID --organization-title VALUE Set the current organization context for the request --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-provisioning-template [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated --provisioning-templates LIST List of provisioning template names --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-smart-proxy [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --smart-proxy VALUE Name to search by --smart-proxy-id NUMBER --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-subnet [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --subnet VALUE Subnet name --subnet-id NUMBER --title VALUE Set the current location context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location remove-user [OPTIONS] Options: --id VALUE --name VALUE Set the current location context for the request --title VALUE Set the current location context for the request --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --location VALUE Set the current location context for the request --location-id NUMBER --location-title VALUE Set the current location context for the request --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer location update [OPTIONS] Options: --compute-resource-ids LIST Compute resource IDs --compute-resources LIST --description VALUE --domain-ids LIST Domain IDs --domains LIST --environment-ids LIST Environment IDs --hostgroup-ids LIST Host group IDs --hostgroup-titles LIST --hostgroups LIST --id VALUE Location numeric id to search by --ignore-types LIST List of resources types that will be automatically associated --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --media LIST --medium-ids LIST Medium IDs --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST Associated organization IDs --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --parent-id NUMBER Parent ID --partition-table-ids LIST Partition template IDs --partition-tables LIST --provisioning-template-ids LIST Provisioning template IDs --provisioning-templates LIST --realm-ids LIST Realm IDs --realms LIST --smart-proxies LIST --smart-proxy-ids LIST Capsule IDs --subnet-ids LIST Subnet IDs --subnets LIST --title VALUE Set the current location context for the request --user-ids LIST User IDs --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer mail-notification [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show an email notification list, index List of email notifications Options: -h, --help Print help", "Usage: hammer mail-notification <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Numerical ID or email notification name --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Subscription type | x | x | ------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer mail-notification <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: description text name string user string", "Usage: hammer medium [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create a medium delete, destroy Delete a medium info, show Show a medium list, index List all installation media remove-operatingsystem Disassociate an operating system update Update a medium Options: -h, --help Print help", "Usage: hammer medium add-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Medium name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer medium create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Name of media --operatingsystem-ids LIST --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --os-family VALUE Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver --path VALUE The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture). For example mirror.centos.org/centos/USDversion/os/USDarch where USDarch will be substituted for the host's actual OS architecture and USDversion, USDmajor and USDminor will be substituted for the version of the operating system. Solaris and Debian media may also use USDrelease. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer medium <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Medium name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer medium <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Medium name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Name | x | x | x Path | x | x | Os family | x | x | Operating systems/ | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer medium <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Path | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: family string location string location_id integer name string organization string organization_id integer path string", "Usage: hammer medium remove-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Medium name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer medium update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE Name of media --new-name VALUE Name of media --operatingsystem-ids LIST --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --os-family VALUE Operating system family, available values: AIX, Altlinux, Archlinux, Coreos, Debian, Fcos, Freebsd, Gentoo, Junos, NXOS, Rancheros, Redhat, Rhcos, Solaris, Suse, VRP, Windows, Xenserver --path VALUE The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture). For example mirror.centos.org/centos/USDversion/os/USDarch where USDarch will be substituted for the host's actual OS architecture and USDversion, USDmajor and USDminor will be substituted for the version of the operating system. Solaris and Debian media may also use USDrelease. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer model [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a hardware model delete, destroy Delete a hardware model info, show Show a hardware model list, index List all hardware models update Update a hardware model Options: -h, --help Print help", "Usage: hammer model create [OPTIONS] Options: --hardware-model VALUE --info VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vendor-class VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer model <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Model name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer model <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Model name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Vendor class | x | x | Hw model | x | x | Info | x | x | Created at | x | x | Updated at | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer model <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Vendor class | x | x | Hw model | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: hardware_model string info text name string vendor_class string", "Usage: hammer model update [OPTIONS] Options: --hardware-model VALUE --id VALUE --info VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --vendor-class VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer module-stream [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a module stream list, index List module streams Options: -h, --help Print help", "Usage: hammer module-stream <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A module stream identifier --name VALUE Module stream name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | Module stream name | x | x | x Stream | x | x | Uuid | x | x | Version | x | x | Architecture | x | x | Context | x | x | Repositories/id | x | x | Repositories/name | x | x | Repositories/label | x | x | Artifacts/id | x | x | Artifacts/name | x | x | Profiles/id | x | x | Profiles/name | x | x | Profiles/rpms/id | x | x | Profiles/rpms/name | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer module-stream <list|index> [OPTIONS] Options: --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host-ids LIST List of host id to list available module streams for --hosts LIST --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment-id NUMBER Environment identifier --name-stream-only BOOLEAN Return name and stream information only) --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | Module stream name | x | x | x Stream | x | x | Uuid | x | x | Version | x | x | Architecture | x | x | Context | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-compute-resource Associate a compute resource add-domain Associate a domain add-hostgroup Associate a hostgroup add-location Associate a location add-medium Associate a medium add-provisioning-template Associate provisioning templates add-smart-proxy Associate a smart proxy add-subnet Associate a subnet add-user Associate an user configure-cdn Update the CDN configuration create Create organization delete, destroy Delete an organization delete-parameter Delete parameter for an organization info, show Show organization list, index List all organizations remove-compute-resource Disassociate a compute resource remove-domain Disassociate a domain remove-hostgroup Disassociate a hostgroup remove-location Disassociate a location remove-medium Disassociate a medium remove-provisioning-template Disassociate provisioning templates remove-smart-proxy Disassociate a smart proxy remove-subnet Disassociate a subnet remove-user Disassociate an user set-parameter Create or update parameter for an organization update Update organization Options: -h, --help Print help", "Usage: hammer organization add-compute-resource [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id NUMBER --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-domain [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-hostgroup [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-location [OPTIONS] Options: --id VALUE Organization ID --location VALUE Set the current location context for the request --location-id NUMBER --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-medium [OPTIONS] Options: --id VALUE Organization ID --medium VALUE Medium name --medium-id NUMBER --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-provisioning-template [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated --provisioning-templates LIST List of provisioning template names --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-smart-proxy [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --smart-proxy VALUE Name to search by --smart-proxy-id NUMBER --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-subnet [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --subnet VALUE Subnet name --subnet-id NUMBER --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization add-user [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization configure-cdn [OPTIONS] Options: --id VALUE ID of the Organization --label VALUE Organization label to search by --name VALUE Organization name to search by --password VALUE Password for authentication. Relevant only for 'upstream_server' type. --ssl-ca-credential-id NUMBER Content Credential to use for SSL CA. Relevant only for 'upstream_server' type. --title VALUE Organization title --type VALUE CDN configuration type. One of redhat_cdn, network_sync, export_sync. --upstream-content-view-label VALUE Upstream Content View Label, default: Default_Organization_View. Relevant only for 'upstream_server' type. --upstream-lifecycle-environment-label VALUE Upstream Lifecycle Environment, default: Library. Relevant only for 'upstream_server' type. --upstream-organization-label VALUE Upstream organization to sync CDN content from. Relevant only for 'upstream_server' type. --url VALUE Upstream satellite server to sync CDN content from. Relevant only for 'upstream_server' type. --username VALUE Username for authentication. Relevant only for 'upstream_server' type. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization create [OPTIONS] Options: --compute-resource-ids LIST Compute resource IDs --compute-resources LIST --description VALUE --domain-ids LIST Domain IDs --domains LIST --environment-ids LIST Environment IDs --hostgroup-ids LIST Host group IDs --hostgroup-titles LIST --hostgroups LIST --label VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Associated location IDs --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --media LIST --medium-ids LIST Medium IDs --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-label VALUE Organization label to search by --organization-title VALUE Set the current organization context for the request --partition-table-ids LIST Partition template IDs --partition-tables LIST --provisioning-template-ids LIST Provisioning template IDs --provisioning-templates LIST --realm-ids LIST Realm IDs --realms LIST --smart-proxies LIST --smart-proxy-ids LIST Capsule IDs --subnet-ids LIST Subnet IDs --subnets LIST --user-ids LIST User IDs --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization <delete|destroy> [OPTIONS] Options: --async Do not wait for the task --id VALUE --label VALUE Organization label to search by --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-label VALUE Organization label to search by --organization-title VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization delete-parameter [OPTIONS] Options: --name VALUE Parameter name --organization VALUE Set the current organization context for the request --organization-id NUMBER Organization ID --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --label VALUE Organization label to search by --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-label VALUE Organization label to search by --organization-title VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------------------|-----|---------|----- Id | x | x | x Title | x | x | x Name | x | x | x Description | x | x | Parent | x | x | Users/ | x | x | Smart proxies/ | x | x | Subnets/ | x | x | Compute resources/ | x | x | Installation media/ | x | x | Templates/ | x | x | Partition tables/ | x | x | Domains/ | x | x | Realms/ | x | x | Hostgroups/ | x | x | Parameters/ | x | x | Locations/ | x | x | Created at | x | x | Updated at | x | x | Label | x | x | x Description | x | x | Simple content access | x | x | Service levels | x | x | Cdn configuration/url | x | x | Cdn configuration/upstream organization | x | x | Cdn configuration/username | x | x | Cdn configuration/ssl ca credential id | x | x | ----------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-label VALUE Organization label to search by --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --sort-by VALUE Field to sort the results on --sort-order VALUE How to order the sorted results (e.g. ASC for ascending) -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Title | x | x | x Name | x | x | x Description | x | x | Label | x | x | x ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: description text id integer label string name string organization_id integer title string", "Usage: hammer organization remove-compute-resource [OPTIONS] Options: --compute-resource VALUE Compute resource name --compute-resource-id NUMBER --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-domain [OPTIONS] Options: --domain VALUE Domain name --domain-id NUMBER Numerical ID or domain name --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-hostgroup [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id NUMBER --hostgroup-title VALUE Hostgroup title --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-location [OPTIONS] Options: --id VALUE Organization ID --location VALUE Set the current location context for the request --location-id NUMBER --location-title VALUE Set the current location context for the request --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-medium [OPTIONS] Options: --id VALUE Organization ID --medium VALUE Medium name --medium-id NUMBER --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-provisioning-template [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated --provisioning-templates LIST List of provisioning template names --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-smart-proxy [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --smart-proxy VALUE Name to search by --smart-proxy-id NUMBER --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-subnet [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --subnet VALUE Subnet name --subnet-id NUMBER --title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization remove-user [OPTIONS] Options: --id VALUE Organization ID --name VALUE Set the current organization context for the request --title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --organization VALUE Set the current organization context for the request --organization-id NUMBER Organization ID --organization-title VALUE Set the current organization context for the request --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer organization update [OPTIONS] Options: --compute-resource-ids LIST Compute resource IDs --compute-resources LIST --description VALUE --domain-ids LIST Domain IDs --domains LIST --environment-ids LIST Environment IDs --hostgroup-ids LIST Host group IDs --hostgroup-titles LIST --hostgroups LIST --id VALUE --label VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST Associated location IDs --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --media LIST --medium-ids LIST Medium IDs --name VALUE --new-name VALUE --new-title VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-label VALUE Organization label to search by --organization-title VALUE Set the current organization context for the request --partition-table-ids LIST Partition template IDs --partition-tables LIST --provisioning-template-ids LIST Provisioning template IDs --provisioning-templates LIST --realm-ids LIST Realm IDs --realms LIST --redhat-repository-url VALUE Red Hat CDN URL --smart-proxies LIST --smart-proxy-ids LIST Capsule IDs --subnet-ids LIST Subnet IDs --subnets LIST --title VALUE Set the current organization context for the request --user-ids LIST User IDs --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-architecture Associate an architecture add-provisioning-template Associate provisioning templates add-ptable Associate a partition table create Create an operating system delete, destroy Delete an operating system delete-default-template delete-parameter Delete parameter for an operating system info, show Show an operating system list, index List all operating systems remove-architecture Disassociate an architecture remove-provisioning-template Disassociate provisioning templates remove-ptable Disassociate a partition table set-default-template set-parameter Create or update parameter for an operating system update Update an operating system Options: -h, --help Print help", "Usage: hammer os add-architecture [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id NUMBER --id VALUE --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os add-provisioning-template [OPTIONS] Options: --id VALUE --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated --provisioning-templates LIST List of provisioning template names --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os add-ptable [OPTIONS] Options: --id VALUE --partition-table VALUE Partition table name --partition-table-id NUMBER --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os create [OPTIONS] Options: --architecture-ids LIST IDs of associated architectures --architectures LIST --description VALUE --family VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --major VALUE --media LIST --medium-ids LIST IDs of associated media --minor VALUE --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --os-parameters-attributes SCHEMA Array of parameters --partition-table-ids LIST IDs of associated partition tables --partition-tables LIST --password-hash ENUM Root password hash function to use Possible value(s): 'SHA256', 'SHA512', 'Base64', 'Base64-Windows', 'MD5' --provisioning-template-ids LIST IDs of associated provisioning templates --provisioning-templates LIST --release-name VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --os-parameters-attributes \"name=<string>\\,value=<string>, ... \"", "Usage: hammer os <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os delete-default-template [OPTIONS] Options: --id VALUE Operatingsystem id --type VALUE Type of the provisioning template -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os delete-parameter [OPTIONS] Options: --name VALUE Parameter name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values --title VALUE Operating system title -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Title | x | x | x Release name | x | x | Family | x | x | Name | x | x | Major version | x | x | Minor version | x | x | Partition tables/ | x | x | Default templates/ | x | x | Architectures/ | x | x | Installation media/ | x | x | Templates/ | x | x | Parameters/ | x | x | --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os <list|index> [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id VALUE ID of architecture --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --medium VALUE Medium name --medium-id VALUE ID of medium --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --os-parameters-attributes SCHEMA Array of parameters --page NUMBER Page number, starting at 1 --partition-table VALUE Partition table name --partition-table-id VALUE ID of partition table --per-page VALUE Number of results per page to return, 'all' to return all results --provisioning-template VALUE Name to search by --provisioning-template-id VALUE ID of template --search VALUE Filter results -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Title | x | x | x Release name | x | x | Family | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --os-parameters-attributes \"name=<string>\\,value=<string>, ... \" Search / Order fields: architecture string description string family string major string medium string minor string name string params string template string title string", "Usage: hammer os remove-architecture [OPTIONS] Options: --architecture VALUE Architecture name --architecture-id NUMBER --id VALUE --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os remove-provisioning-template [OPTIONS] Options: --id VALUE --provisioning-template VALUE Name to search by --provisioning-template-id NUMBER --provisioning-template-ids LIST List of provisioning template ids --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated --provisioning-templates LIST List of provisioning template names --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os remove-ptable [OPTIONS] Options: --id VALUE --partition-table VALUE Partition table name --partition-table-id NUMBER --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os set-default-template [OPTIONS] Options: --id VALUE Operatingsystem id --provisioning-template-id VALUE Provisioning template id to be set -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer os update [OPTIONS] Options: --architecture-ids LIST IDs of associated architectures --architectures LIST --description VALUE --family VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --major VALUE --media LIST --medium-ids LIST IDs of associated media --minor VALUE --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --os-parameters-attributes SCHEMA Array of parameters --partition-table-ids LIST IDs of associated partition tables --partition-tables LIST --password-hash ENUM Root password hash function to use Possible value(s): 'SHA256', 'SHA512', 'Base64', 'Base64-Windows', 'MD5' --provisioning-template-ids LIST IDs of associated provisioning templates --provisioning-templates LIST --release-name VALUE --title VALUE Operating system title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value): --os-parameters-attributes \"name=<string>\\,value=<string>, ... \"", "Usage: hammer package [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a package list, index List packages Options: -h, --help Print help", "Usage: hammer package <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A package identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Pulp id | x | x | Uuid | x | x | Name | x | x | x Version | x | x | Architecture | x | x | Epoch | x | x | Release | x | x | Author | x | x | Filename | x | x | Source rpm | x | x | Nvrea | x | x | Build host | x | x | Available host count | x | x | Applicable host count | x | x | Children | x | x | Vendor | x | x | License | x | x | Relative path | x | x | Description | x | x | Summary | x | x | Url | x | x | Build time | x | x | Group | x | x | Requires | x | x | Provides | x | x | Files | x | x | Size | x | x | Modular | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer package <list|index> [OPTIONS] Options: --available-for VALUE Return packages that can be added to the specified object. Only the value 'content_view_version' is supported. --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content View Filter identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Host id to list applicable packages for --ids LIST Package identifiers to filter content by --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --packages-restrict-applicable BOOLEAN Return packages that are applicable to one or more hosts (defaults to true if host_id is specified) --packages-restrict-latest BOOLEAN Return only the latest version of each package --packages-restrict-upgradable BOOLEAN Return packages that are upgradable on one or more hosts --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: -----------|-----|-------- FIELDS | ALL | DEFAULT -----------|-----|-------- Id | x | x Filename | x | x Source rpm | x | x -----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer package-group [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a package group list, index List package_groups Options: -h, --help Print help", "Usage: hammer package-group <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE A package group identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: ---------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------|-----|---------|----- Id | x | x | x Package group name | x | x | x Repository name | x | x | Uuid | x | x | Description | x | x | Default packages | x | x | Mandatory packages | x | x | Conditional packages | x | x | Optional packages | x | x | ---------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer package-group <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-filter VALUE Name to search by --content-view-filter-id NUMBER Content view filter identifier --content-view-filter-rule VALUE Name to search by --content-view-filter-rule-id NUMBER Content view filter rule identifier --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content view version identifier --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --ids LIST Ids to filter content by --include-filter-ids BOOLEAN Includes associated content view filter ids in response --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Package group name | x | x | x Repository name | x | x | Uuid | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system create Create a partition table delete, destroy Delete a partition table dump View partition table content info, show Show a partition table list, index List all partition tables remove-operatingsystem Disassociate an operating system update Update a partition table Options: -h, --help Print help", "Usage: hammer partition-table add-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Partition table name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table create [OPTIONS] Options: --audit-comment VALUE --description VALUE --file FILE Path to a file that contains the partition layout --host-ids LIST Array of host IDs to associate with the partition table --hostgroup-ids LIST Array of host group IDs to associate with the partition table --hostgroup-titles LIST --hostgroups LIST --hosts LIST --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --operatingsystem-ids LIST Array of operating system IDs to associate with the partition table --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --os-family VALUE --snippet BOOLEAN -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Partition table name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table dump [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Partition table name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Partition table name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Name | x | x | x Os family | x | x | Description | x | x | Locked | x | x | Operating systems/ | x | x | Created at | x | x | Updated at | x | x | Locations/ | x | x | Organizations/ | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ----------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------|-----|---------|----- Id | x | x | x Name | x | x | x Os family | x | x | ----------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: default Values: true, false family string layout text location string location_id integer locked Values: true, false name string organization string organization_id integer snippet Values: true, false template text vendor string", "Usage: hammer partition-table remove-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Partition table name --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer partition-table update [OPTIONS] Options: --audit-comment VALUE --description VALUE --file FILE Path to a file that contains the partition layout --host-ids LIST Array of host IDs to associate with the partition table --hostgroup-ids LIST Array of host group IDs to associate with the partition table --hostgroup-titles LIST --hostgroups LIST --hosts LIST --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --new-name VALUE --operatingsystem-ids LIST Array of operating system IDs to associate with the partition table --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --os-family VALUE --snippet BOOLEAN -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer ping [OPTIONS] [SUBCOMMAND] [ARG] Parameters: [ARG] ... Subcommand arguments [SUBCOMMAND] Subcommand (default: \"foreman\") Subcommands: foreman Shows status of Satellite system and it's subcomponents katello Shows status of Katello system and it's subcomponents Options: -h, --help Print help", "Usage: hammer ping foreman [OPTIONS] Options: -h, --help Print help", "Usage: hammer ping katello [OPTIONS] Options: -h, --help Print help", "Usage: hammer policy [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Policy delete, destroy Delete a Policy hosts List all hosts info, show Show a Policy list, index List Policies update Update a Policy Options: -h, --help Print help", "Usage: hammer policy create [OPTIONS] Options: --cron-line VALUE Policy schedule cron line (only if period == \"custom\") --day-of-month NUMBER Policy schedule day of month (only if period == \"monthly\") --deploy-by ENUM How the policy should be deployed Possible value(s): 'puppet', 'ansible', 'manual' --description VALUE Policy description --host-ids LIST Apply policy to hosts --hostgroup-ids LIST Apply policy to host groups --hostgroups LIST --hosts LIST --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --name VALUE Policy name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --period VALUE Policy schedule period (weekly, monthly, custom) --scap-content VALUE SCAP content title --scap-content-id NUMBER Policy SCAP content ID --scap-content-profile VALUE Name to search by --scap-content-profile-id NUMBER Policy SCAP content profile ID --tailoring-file VALUE Tailoring file name --tailoring-file-id NUMBER Tailoring file ID --tailoring-file-profile-id NUMBER Tailoring file profile ID --weekday VALUE Policy schedule weekday (only if period == \"weekly\") -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer policy <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer policy hosts [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --id VALUE Policy Id --include ENUM Array of extra information types to include Possible value(s): 'parameters', 'all_parameters' --location VALUE Set the current location context for the request --location-id VALUE ID of location --location-title VALUE Set the current location context for the request --name VALUE Policy name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id VALUE ID of organization --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --thin BOOLEAN Only list ID and name of hosts -h, --help Print help Predefined field sets: -----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------|-----|---------|----- Id | x | x | x Name | x | x | x Operating system | x | x | Host group | x | x | Ip | x | x | Mac | x | x | Global status | x | x | Organization | x | | Location | x | | Additional information | x | | Content view | x | x | Lifecycle environment | x | x | Security | x | | Bugfix | x | | Enhancement | x | | Trace status | x | x | -----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: activation_key string activation_key_id string addon string addons_status Values: mismatched, matched, not_specified ansible_role string applicable_debs string applicable_errata string applicable_errata_issued date applicable_rpms string architecture string autoheal boolean boot_time build Values: true, false build_status Values: built, pending, token_expired, build_failed comment text compute_resource string compute_resource_id integer content_source string content_view string content_view_id integer created_at datetime cve_id integer domain string domain_id integer errata_status Values: security_needed, errata_needed, updated, unknown execution_status Values: ok, error facts string global_status Values: ok, warning, error has_ip string has_mac string hostgroup string hostgroup_fullname string hostgroup_id integer hostgroup_name string hostgroup_title string hypervisor boolean hypervisor_host string id integer image string infrastructure_facet.foreman infrastructure_facet.smart_proxy_id insights_recommendations_count integer installable_errata string installed_at datetime ip string job_invocation.id string job_invocation.result Values: cancelled, failed, pending, success last_checkin datetime last_report datetime lifecycle_environment string lifecycle_environment_id integer location string location_id integer mac string managed Values: true, false model string name string organization string organization_id integer origin string os string os_description string os_id integer os_major string os_minor string os_title string owner string owner_id integer owner_type string params string params_name string parent_hostgroup string puppet_ca string puppet_proxy_id integer puppetmaster string purpose_status Values: mismatched, matched, not_specified realm string realm_id integer registered_at datetime registered_through string release_version string reported.boot_time reported.cores reported.disks_total reported.ram reported.sockets reported.virtual Values: true, false repository string repository_content_label string role text role_status Values: mismatched, matched, not_specified service_level string sla_status Values: mismatched, matched, not_specified smart_proxy string status.applied integer status.enabled Values: true, false status.failed integer status.failed_restarts integer status.interesting Values: true, false status.pending integer status.restarted integer status.skipped integer subnet string subnet.name text subnet6 string subnet6.name text subscription_id string subscription_name string subscription_status Values: valid, partial, invalid, unknown, disabled, unsubscribed_hypervisor subscription_uuid string trace_status Values: reboot_needed, process_restart_needed, updated upgradable_debs string upgradable_rpms string usage text usage_status Values: mismatched, matched, not_specified user.firstname string user.lastname string user.login string user.mail string usergroup string usergroup.name string uuid string", "Usage: hammer policy <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Created at | x | x | Period | x | x | Weekday | x | x | Day of month | x | x | Cron line | x | x | Scap content id | x | x | Scap content profile id | x | x | Tailoring file id | x | x | Tailoring file profile id | x | x | Deployment option | x | x | Locations/ | x | x | Organizations/ | x | x | Hostgroups/ | x | x | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer policy <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------|-----|---------|----- Id | x | x | x Name | x | x | x Created at | x | x | -----------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content string location string location_id integer name string organization string organization_id integer profile string tailoring_file string tailoring_file_profile string", "Usage: hammer policy update [OPTIONS] Options: --cron-line VALUE Policy schedule cron line (only if period == \"custom\") --day-of-month NUMBER Policy schedule day of month (only if period == \"monthly\") --deploy-by ENUM How the policy should be deployed Possible value(s): 'puppet', 'ansible', 'manual' --description VALUE Policy description --host-ids LIST Apply policy to hosts --hostgroup-ids LIST Apply policy to host groups --hostgroups LIST --hosts LIST --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --name VALUE Policy name --new-name VALUE Policy name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --period VALUE Policy schedule period (weekly, monthly, custom) --scap-content VALUE SCAP content title --scap-content-id NUMBER Policy SCAP content ID --scap-content-profile VALUE Name to search by --scap-content-profile-id NUMBER Policy SCAP content profile ID --tailoring-file VALUE Tailoring file name --tailoring-file-id NUMBER Tailoring file ID --tailoring-file-profile-id NUMBER Tailoring file profile ID --weekday VALUE Policy schedule weekday (only if period == \"weekly\") -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer prebuild-bash-completion [OPTIONS] Options: -h, --help Print help", "Usage: hammer product [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a product delete, destroy Destroy a product info, show Show a product list, index List products remove-sync-plan Delete assignment sync plan and product set-sync-plan Assign sync plan to product synchronize Sync all repositories for a product update Updates a product update-proxy Updates an HTTP Proxy for a product Options: -h, --help Print help", "Usage: hammer product create [OPTIONS] Options: --description VALUE Product description --gpg-key-id NUMBER Identifier of the GPG key --label VALUE --name VALUE Product name --organization VALUE Organization name to search by --organization-id NUMBER ID of the organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --ssl-ca-cert-id NUMBER Idenifier of the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the SSL Client Key --sync-plan VALUE Sync plan name to search by --sync-plan-id NUMBER Plan numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product <delete|destroy> [OPTIONS] Options: --id NUMBER Product numeric identifier --name VALUE Product name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Product numeric identifier --name VALUE Product name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: ---------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------|-----|---------|----- Id | x | x | x Name | x | x | x Label | x | x | Description | x | x | Sync state (all) | x | x | Sync state (last) | x | x | Sync plan id | x | x | Gpg/gpg key id | x | x | Gpg/gpg key | x | x | Organization | x | x | Readonly | x | x | Deletable | x | x | Content/repo name | x | x | Content/url | x | x | Content/content type | x | x | ---------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product <list|index> [OPTIONS] Options: --available-for VALUE Interpret specified object to return only Products that can be associated with specified object. Only 'sync_plan' is supported. --custom BOOLEAN Return custom products only --enabled BOOLEAN Return enabled products only --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --include-available-content BOOLEAN Whether to include available content attribute in results --name VALUE Filter products by name --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Filter products by organization --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --redhat-only BOOLEAN Return Red Hat (non-custom) products only --search VALUE Search string --subscription VALUE Subscription name to search by --subscription-id NUMBER Filter products by subscription --sync-plan VALUE Sync plan name to search by --sync-plan-id NUMBER Filter products by sync plan id -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Organization | x | x | Repositories | x | x | Sync state | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: description text label string name string organization_id integer redhat Values: true, false", "Usage: hammer product remove-sync-plan [OPTIONS] Options: --description VALUE Product description --gpg-key-id NUMBER Identifier of the GPG key --id NUMBER Product numeric identifier --name VALUE Product name --new-name VALUE Product name --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --ssl-ca-cert-id NUMBER Idenifier of the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the SSL Client Key -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product set-sync-plan [OPTIONS] Options: --id NUMBER Product numeric identifier --name VALUE Product name to search by --new-name VALUE Product name --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --ssl-ca-cert-id NUMBER Idenifier of the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the SSL Client Key --sync-plan VALUE Sync plan name to search by --sync-plan-id NUMBER Plan numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product synchronize [OPTIONS] Options: --async Do not wait for the task --id NUMBER Product ID --name VALUE Product name to search by --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product update [OPTIONS] Options: --description VALUE Product description --gpg-key-id NUMBER Identifier of the GPG key --id NUMBER Product numeric identifier --name VALUE Product name --new-name VALUE Product name --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --ssl-ca-cert-id NUMBER Idenifier of the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the SSL Client Key --sync-plan VALUE Sync plan name to search by --sync-plan-id NUMBER Plan numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer product update-proxy [OPTIONS] Options: --http-proxy VALUE Name to search by --http-proxy-id NUMBER HTTP Proxy identifier to associated --http-proxy-policy ENUM Policy for HTTP Proxy for content sync Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy' --ids LIST List of product ids -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: content Manage the capsule content create Create a capsule delete, destroy Delete a capsule info, show Show a capsule list, index List all capsules refresh-features Refresh capsule features update Update a capsule Options: -h, --help Print help", "Usage: hammer proxy content [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-lifecycle-environment Add lifecycle environments to the capsule available-lifecycle-environments List the lifecycle environments not attached to the capsule cancel-synchronization Cancel running capsule synchronization info Get current capsule synchronization status lifecycle-environments List the lifecycle environments attached to the capsule remove-lifecycle-environment Remove lifecycle environments from the capsule synchronization-status Get current capsule synchronization status synchronize Synchronize the content to the capsule Options: -h, --help Print help", "Usage: hammer proxy content add-lifecycle-environment [OPTIONS] Options: --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content available-lifecycle-environments [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content cancel-synchronization [OPTIONS] Options: --id NUMBER Id of the capsule --name VALUE Name to search by -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content info [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------------------------------------------------------------|-----|-------- FIELDS | ALL | DEFAULT -------------------------------------------------------------------|-----|-------- Lifecycle environments/name | x | x Lifecycle environments/organization | x | x Lifecycle environments/content views/name | x | x Lifecycle environments/content views/composite | x | x Lifecycle environments/content views/last published | x | x Lifecycle environments/content views/content/hosts | x | x Lifecycle environments/content views/content/products | x | x Lifecycle environments/content views/content/yum repos | x | x Lifecycle environments/content views/content/container image repos | x | x Lifecycle environments/content views/content/packages | x | x Lifecycle environments/content views/content/package groups | x | x Lifecycle environments/content views/content/errata | x | x -------------------------------------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content lifecycle-environments [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to limit environments on --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Organization | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content remove-lifecycle-environment [OPTIONS] Options: --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the lifecycle environment --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content synchronization-status [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Id of the capsule --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Id of the organization to get the status for --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: --------------------------------------|-----|-------- FIELDS | ALL | DEFAULT --------------------------------------|-----|-------- Last sync | x | x Status | x | x Currently running sync tasks/task id | x | x Currently running sync tasks/progress | x | x Last failure/task id | x | x Last failure/messages | x | x --------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy content synchronize [OPTIONS] Options: --async Do not wait for the task --content-view VALUE Content view name to search by --content-view-id NUMBER Id of the content view to limit the synchronization on --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --id NUMBER Id of the capsule --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Id of the environment to limit the synchronization on --name VALUE Name to search by --organization VALUE Organization name --organization-id VALUE Organization ID --repository VALUE Repository name to search by --repository-id NUMBER Id of the repository to limit the synchronization on --skip-metadata-check BOOLEAN Skip metadata check on each repository on the capsule -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy create [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --include-status BOOLEAN Flag to indicate whether to include status or not --include-version BOOLEAN Flag to indicate whether to include version or not --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | Version | x | x | Host_count | x | x | Features/name | x | x | Features/version | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --include-status BOOLEAN Flag to indicate whether to include status or not --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Status | x | x | Url | x | x | Features | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: feature string location string location_id integer name string organization string organization_id integer url string Search / Order fields: feature string location string location_id integer name string organization string organization_id integer url string", "Usage: hammer proxy refresh-features [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer proxy update [OPTIONS] Options: --download-policy VALUE Download Policy of the capsule, must be one of on_demand, immediate, inherit --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --url VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer realm [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a realm delete, destroy Delete a realm info, show Show a realm list, index List of realms update Update a realm Options: -h, --help Print help", "Usage: hammer realm create [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The realm name, e.g. EXAMPLE.COM --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --realm-proxy-id NUMBER Capsule ID to use within this realm --realm-type VALUE Realm type, e.g. Red Hat Identity Management or Active Directory -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer realm <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer realm <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE Numerical ID or realm name --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Realm proxy id | x | x | Realm type | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer realm <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: location string location_id integer name string organization string organization_id integer type string", "Usage: hammer realm update [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE The realm name, e.g. EXAMPLE.COM --new-name VALUE The realm name, e.g. EXAMPLE.COM --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --realm-proxy-id NUMBER Capsule ID to use within this realm --realm-type VALUE Realm type, e.g. Red Hat Identity Management or Active Directory -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer recurring-logic [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: cancel Cancel recurring logic delete Delete all recuring logics filtered by the arguments info, show Show recurring logic details list, index List recurring logics Options: -h, --help Print help", "Usage: hammer recurring-logic cancel [OPTIONS] Options: --id VALUE ID of the recurring logic --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer recurring-logic delete [OPTIONS] Options: --cancelled Only delete cancelled recurring logics --finished Only delete finished recurring logics -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer recurring-logic <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE ID of the recurring logic --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------|-----|-------- FIELDS | ALL | DEFAULT ----------------|-----|-------- Id | x | x Cron line | x | x Action | x | x Last occurrence | x | x Next occurrence | x | x Iteration | x | x Iteration limit | x | x Repeat until | x | x State | x | x ----------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer recurring-logic <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ----------|-----|-------- FIELDS | ALL | DEFAULT ----------|-----|-------- Id | x | x Cron line | x | x Iteration | x | x End time | x | x State | x | x ----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer remote-execution-feature [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show remote execution feature list, index List remote execution features update Update a job template Options: -h, --help Print help", "Usage: hammer remote-execution-feature <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------|-----|---------|----- Id | x | x | x Label | x | x | Name | x | x | x Description | x | x | Job template name | x | x | Job template id | x | x | ------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer remote-execution-feature <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Job template name | x | x | ------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer remote-execution-feature update [OPTIONS] Options: --id VALUE --job-template VALUE Name to search by --job-template-id VALUE Job template ID to be used for the feature --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete, destroy Delete a report info, show Show a report list, index List all reports Options: -h, --help Print help", "Usage: hammer report <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------|-----|---------|----- Id | x | x | x Host | x | x | Reported at | x | x | Origin | x | x | Report status/applied | x | x | Report status/restarted | x | x | Report status/failed | x | x | Report status/restart failures | x | x | Report status/skipped | x | x | Report status/pending | x | x | Report metrics/config_retrieval | x | x | Report metrics/exec | x | x | Report metrics/file | x | x | Report metrics/package | x | x | Report metrics/service | x | x | Report metrics/user | x | x | Report metrics/yumrepo | x | x | Report metrics/filebucket | x | x | Report metrics/cron | x | x | Report metrics/total | x | x | Logs/resource | x | x | Logs/message | x | x | --------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------|-----|---------|----- Id | x | x | x Host | x | x | Last report | x | x | Origin | x | x | Applied | x | x | Restarted | x | x | Failed | x | x | Restart failures | x | x | Skipped | x | x | Pending | x | x | -----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer Search / Order fields: applied integer eventful Values: true, false failed integer failed_restarts integer host string host_id integer host_owner_id integer hostgroup string hostgroup_fullname string hostgroup_title string last_report datetime location string log text organization string origin string pending integer reported datetime resource text restarted integer skipped integer", "Usage: hammer report-template [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: clone Clone a template create Create a report template delete, destroy Delete a report template dump View report content generate Generate report import Import a report template info, show Show a report template list, index List all report templates report-data Downloads a generated report schedule Schedule generating of a report update Update a report template Options: -h, --help Print help", "Usage: hammer report-template clone [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Template name --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template create [OPTIONS] Options: --audit-comment VALUE --default BOOLEAN Whether or not the template is added automatically to new organizations and locations --description VALUE --file FILE Path to a file that contains the report template content --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --snippet BOOLEAN -h, --help Print help -i, --interactive Open empty template in an USDEDITOR. Upload the result Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template dump [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template generate [OPTIONS] Options: --gzip BOOLEAN Compress the report uzing gzip --id VALUE --inputs KEY_VALUE_LIST Specify inputs --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --path VALUE Path to directory where downloaded content will be saved --report-format ENUM Report format, defaults to 'csv' Possible value(s): 'csv', 'json', 'yaml', 'html' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template import [OPTIONS] Options: --associate ENUM Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): 'new', 'always', 'never' --default BOOLEAN Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) --file FILE Path to a file that contains the report template content including metadata --force BOOLEAN Use if you want update locked templates --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --lock BOOLEAN Lock imported templates (false by default) --name VALUE Template name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Locked | x | x | Default | x | x | Created at | x | x | Updated at | x | x | Locations/ | x | x | Organizations/ | x | x | Template inputs/id | x | x | Template inputs/name | x | x | Template inputs/description | x | x | Template inputs/required | x | x | Template inputs/options | x | x | ----------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: default Values: true, false location string location_id integer locked Values: true, false name string organization string organization_id integer snippet Values: true, false template text", "Usage: hammer report-template report-data [OPTIONS] Options: --id VALUE --job-id VALUE ID assigned to generating job by the schedule command --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --path VALUE Path to directory where downloaded content will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template schedule [OPTIONS] Options: --generate-at VALUE UTC time to generate report at --gzip BOOLEAN Compress the report using gzip --id VALUE --inputs KEY_VALUE_LIST Specify inputs --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mail-to VALUE If set, scheduled report will be delivered via e-mail. Use ',' to separate multiple email addresses. --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --path VALUE Path to directory where downloaded content will be saved. Only usable if wait is specified --report-format ENUM Report format, defaults to 'csv' Possible value(s): 'csv', 'json', 'yaml', 'html' --wait Turns a command to be active, wait for the result and download it right away -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer report-template update [OPTIONS] Options: --audit-comment VALUE --default BOOLEAN Whether or not the template is added automatically to new organizations and locations --description VALUE --file FILE Path to a file that contains the report template content --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --snippet BOOLEAN -h, --help Print help -i, --interactive Dump existing template and open it in an USDEDITOR. Update with the result Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a custom repository delete, destroy Destroy a custom repository info, show Show a repository list, index List of enabled repositories reclaim-space Reclaim space from an On Demand repository remove-content Remove content from a repository synchronize Sync a repository update Update a repository upload-content Upload content into the repository Options: -h, --help Print help", "Usage: hammer repository create [OPTIONS] Options: --ansible-collection-auth-token VALUE The token key to use for authentication. --ansible-collection-auth-url VALUE The URL to receive a session token from, e.g. used with Automation Hub. --ansible-collection-requirements VALUE Contents of requirement yaml file to sync from URL --ansible-collection-requirements-file VALUE Location of the ansible collections requirements.yml file. --arch VALUE Architecture of content in the repository --checksum-type VALUE Checksum of the repository, currently 'sha1' & 'sha256' are supported --content-type ENUM Type of repo Possible value(s): 'ansible_collection', 'deb', 'docker', 'file', 'ostree', 'python', 'yum' --deb-architectures VALUE Whitespace-separated list of architectures to be synced from deb-archive --deb-components VALUE Whitespace-separated list of repo components to be synced from deb-archive --deb-releases VALUE Whitespace-separated list of releases to be synced from deb-archive --description VALUE Description of the repository --docker-tags-whitelist LIST Comma-separated list of tags to sync for Container Image repository (Deprecated) --docker-upstream-name VALUE Name of the upstream docker repository --download-concurrency NUMBER Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10 --download-policy ENUM Download policy for yum repos (either 'immediate' or 'on_demand') Possible value(s): 'immediate', 'on_demand' --exclude-tags LIST Comma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in \"-source\" --excludes LIST Python packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. --gpg-key-id NUMBER Id of the gpg key that will be assigned to the new repository --http-proxy VALUE Name to search by --http-proxy-id NUMBER ID of a HTTP Proxy --http-proxy-policy ENUM Policies for HTTP Proxy for content sync Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy' --ignorable-content LIST List of content units to ignore while syncing a yum repository. Must be subset of srpm --include-tags LIST Comma-separated list of tags to sync for a container image repository --includes LIST Python packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package. --label VALUE --mirror-on-sync BOOLEAN True if this repository when synced has to be mirrored from the source and stale rpms removed (Deprecated) --mirroring-policy ENUM Policy to set for mirroring content. Must be one of additive. Possible value(s): 'additive', 'mirror_complete', 'mirror_content_only' --name VALUE Name of the repository --organization VALUE Organization name to search by --organization-id NUMBER --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --os-versions LIST Identifies whether the repository should be disabled on a client with a non-matching OS version. Pass [] to enable regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9 --package-types LIST Package types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist. --product VALUE Product name to search by --product-id NUMBER Product the repository belongs to --publish-via-http BOOLEAN Publish Via HTTP --retain-package-versions-count NUMBER The maximum number of versions of each package to keep. --ssl-ca-cert-id NUMBER Identifier of the content credential containing the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the content credential containing the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the content credential containing the SSL Client Key --upstream-authentication-token VALUE Password of the upstream authentication token. --upstream-password VALUE Password of the upstream repository user used for authentication --upstream-username VALUE Username of the upstream repository user used for authentication --url VALUE Repository source url --verify-ssl-on-sync BOOLEAN If true, Katello will verify the upstream url's SSL certifcates are signed by a trusted CA -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository <delete|destroy> [OPTIONS] Options: --id NUMBER --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --remove-from-content-view-versions BOOLEAN Force delete the repository by removing it from all content view versions -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Repository ID --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Predefined field sets: ----------------------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Label | x | x | Description | x | x | Organization | x | x | Red hat repository | x | x | Content type | x | x | Checksum type | x | x | Mirroring policy | x | x | Url | x | x | Publish via http | x | x | Published at | x | x | Relative path | x | x | Download policy | x | x | Upstream repository name | x | x | Container image tags filter | x | x | Container repository name | x | x | Ignorable content units | x | x | Http proxy/id | x | x | Http proxy/name | x | x | Http proxy/http proxy policy | x | x | Product/id | x | x | Product/name | x | x | Gpg key/id | x | x | Gpg key/name | x | x | Sync/status | x | x | Sync/last sync date | x | x | Created | x | x | Updated | x | x | Content counts/packages | x | x | Content counts/source rpms | x | x | Content counts/package groups | x | x | Content counts/errata | x | x | Content counts/container image manifest lists | x | x | Content counts/container image manifests | x | x | Content counts/container image tags | x | x | Content counts/files | x | x | Content counts/module streams | x | x | ----------------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository <list|index> [OPTIONS] Options: --ansible-collection VALUE Name to search by --ansible-collection-id VALUE Id of an ansible collection to find repositories that contain the ansible collection --archived BOOLEAN Show archived repositories --available-for VALUE Interpret specified object to return only Repositories that can be associated with specified object. Only 'content_view' & 'content_view_version' are supported. --content-type ENUM Limit to only repositories of this type Possible value(s): 'ansible_collection', 'deb', 'docker', 'file', 'ostree', 'python', 'yum' --content-view VALUE Content view name to search by --content-view-id NUMBER ID of a content view to show repositories in --content-view-version VALUE Content view version number --content-view-version-id NUMBER ID of a content view version to show repositories in --deb VALUE Name to search by --deb-id VALUE Id of a deb package to find repositories that contain the deb --description VALUE Description of the repository --download-policy ENUM Limit to only repositories with this download policy Possible value(s): 'immediate', 'on_demand' --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --erratum-id VALUE Id of an erratum to find repositories that contain the erratum --fields LIST Show specified fields or predefined field sets only. (See below) --file-id VALUE Id of a file to find repositories that contain the file --full-result BOOLEAN Whether or not to show all results --label VALUE Label of the repository --library BOOLEAN Show repositories in Library and the default content view --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER ID of an environment to show repositories in --name VALUE Name of the repository --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER ID of an organization to show repositories in --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER ID of a product to show repositories of --rpm-id VALUE Id of a rpm package to find repositories that contain the rpm --search VALUE Search string --username VALUE Only show the repositories readable by this user with this username --with-content ENUM Only repositories having at least one of the specified content type ex: rpm , erratum Possible value(s): 'ansible_collection', 'deb', 'docker_manifest', 'docker_manifest_list', 'docker_tag', 'docker_blob', 'file', 'ostree_ref', 'python_package', 'rpm', 'modulemd', 'erratum', 'distribution', 'package_category', 'package_group', 'yum_repo_metadata_file', 'srpm' -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Product | x | x | Content type | x | x | Url | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: container_repository_name string content_label string content_type string content_view_id integer description text distribution_arch string distribution_bootable boolean distribution_family string distribution_variant string distribution_version string download_policy string label string name string product string product_id integer product_name string redhat Values: true, false", "Usage: hammer repository reclaim-space [OPTIONS] Options: --async Do not wait for the task --id NUMBER Repository ID --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository remove-content [OPTIONS] Options: --content-type ENUM Content type ('deb', 'docker_manifest', 'file', 'ostree', 'rpm', 'srpm') Possible value(s): 'deb', 'docker_manifest', 'file', 'python_package', 'rpm', 'srpm' --id NUMBER Repository ID --ids LIST Array of content ids to remove --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --sync-capsule BOOLEAN Whether or not to sync an external capsule after upload. Default: true -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository synchronize [OPTIONS] Options: --async Do not wait for the task --id NUMBER Repository ID --incremental BOOLEAN Perform an incremental import --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --skip-metadata-check BOOLEAN Force sync even if no upstream changes are detected. Only used with yum repositories. --source-url VALUE Temporarily override feed URL for sync --validate-contents BOOLEAN Force a sync and validate the checksums of all content. Only used with yum repositories. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository update [OPTIONS] Options: --ansible-collection-auth-token VALUE The token key to use for authentication. --ansible-collection-auth-url VALUE The URL to receive a session token from, e.g. used with Automation Hub. --ansible-collection-requirements VALUE Contents of requirement yaml file to sync from URL --ansible-collection-requirements-file VALUE Location of the ansible collections requirements.yml file. --arch VALUE Architecture of content in the repository --checksum-type VALUE Checksum of the repository, currently 'sha1' & 'sha256' are supported --deb-architectures VALUE Whitespace-separated list of architectures to be synced from deb-archive --deb-components VALUE Whitespace-separated list of repo components to be synced from deb-archive --deb-releases VALUE Whitespace-separated list of releases to be synced from deb-archive --description VALUE Description of the repository --docker-digest VALUE Container Image manifest digest --docker-tag VALUE Container Image tag --docker-tags-whitelist LIST Comma-separated list of tags to sync for Container Image repository (Deprecated) --docker-upstream-name VALUE Name of the upstream docker repository --download-concurrency NUMBER Used to determine download concurrency of the repository in pulp3. Use value less than 20. Defaults to 10 --download-policy ENUM Download policy for yum repos (either 'immediate' or 'on_demand') Possible value(s): 'immediate', 'on_demand' --exclude-tags LIST Comma-separated list of tags to exclude when syncing a container image repository. Default: any tag ending in \"-source\" --excludes LIST Python packages to exclude from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. --gpg-key-id NUMBER Id of the gpg key that will be assigned to the new repository --http-proxy VALUE Name to search by --http-proxy-id NUMBER ID of a HTTP Proxy --http-proxy-policy ENUM Policies for HTTP Proxy for content sync Possible value(s): 'global_default_http_proxy', 'none', 'use_selected_http_proxy' --id NUMBER Repository ID --ignorable-content LIST List of content units to ignore while syncing a yum repository. Must be subset of srpm --include-tags LIST Comma-separated list of tags to sync for a container image repository --includes LIST Python packages to include from the upstream URL, names separated by newline. You may also specify versions, for example: django~=2.0. Leave empty to include every package. --mirror-on-sync BOOLEAN True if this repository when synced has to be mirrored from the source and stale rpms removed (Deprecated) --mirroring-policy ENUM Policy to set for mirroring content. Must be one of additive. Possible value(s): 'additive', 'mirror_complete', 'mirror_content_only' --name VALUE --new-name VALUE --organization VALUE Organization name to search by --organization-id VALUE Organization ID to search by --organization-label VALUE Organization label to search by --os-versions LIST Identifies whether the repository should be disabled on a client with a non-matching OS version. Pass [] to enable regardless of OS version. Maximum length 1; allowed tags are: rhel-6, rhel-7, rhel-8, rhel-9 --package-types LIST Package types to sync for Python content, separated by comma. Leave empty to get every package type. Package types are: bdist_dmg, bdist_dumb, bdist_egg, bdist_msi, bdist_rpm, bdist_wheel, bdist_wininst, sdist. --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --publish-via-http BOOLEAN Publish Via HTTP --retain-package-versions-count NUMBER The maximum number of versions of each package to keep. --ssl-ca-cert-id NUMBER Identifier of the content credential containing the SSL CA Cert --ssl-client-cert-id NUMBER Identifier of the content credential containing the SSL Client Cert --ssl-client-key-id NUMBER Identifier of the content credential containing the SSL Client Key --upstream-authentication-token VALUE Password of the upstream authentication token. --upstream-password VALUE Password of the upstream repository user used for authentication --upstream-username VALUE Username of the upstream repository user used for authentication --url VALUE Repository source url --verify-ssl-on-sync BOOLEAN If true, Katello will verify the upstream url's SSL certifcates are signed by a trusted CA -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository upload-content [OPTIONS] Options: --content-type ENUM Content type ('deb', 'docker_manifest', 'file', 'ostree', 'rpm', 'srpm') Possible value(s): 'deb', 'docker_manifest', 'file', 'ostree_ref', 'python_package', 'rpm', 'srpm' --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Repository ID --name VALUE Repository name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --ostree-repository-name VALUE Name of OSTree repository in archive. --path FILE Upload file, directory of files, or glob of files as content for a repository. Globs must be escaped by single or double quotes --product VALUE Product name to search by --product-id NUMBER Product numeric identifier -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository-set [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: available-repositories Get list of available repositories for the repository set disable Disable a repository from the set enable Enable a repository from the set info, show Get info about a repository set list, index List repository sets. Options: -h, --help Print help", "Usage: hammer repository-set available-repositories [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER ID of the repository set --name VALUE Repository set name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER ID of a product to list repository sets from -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Name | x | x | x Arch | x | x | Release | x | x | Registry name | x | x | Enabled | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository-set disable [OPTIONS] Options: --basearch VALUE Basearch to disable --id NUMBER ID of the repository set to disable --name VALUE Repository set name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER ID of the product containing the repository set --releasever VALUE Releasever to disable --repository VALUE Repository name to search by --repository-id NUMBER ID of the repository within the set to disable -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository-set enable [OPTIONS] Options: --basearch VALUE Basearch to enable --id NUMBER ID of the repository set to enable --name VALUE Repository set name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER ID of the product containing the repository set --releasever VALUE Releasever to enable -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository-set <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER ID of the repository set --name VALUE Repository set name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --product VALUE Product name to search by --product-id NUMBER ID of a product to list repository sets from -h, --help Print help Predefined field sets: --------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Type | x | x | Url | x | x | Gpg key | x | x | Label | x | x | Enabled repositories/id | x | x | Enabled repositories/name | x | x | --------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer repository-set <list|index> [OPTIONS] Options: --activation-key VALUE Activation key name to search by --activation-key-id NUMBER Activation key identifier --content-access-mode-all BOOLEAN Get all content available, not just that provided by subscriptions. --content-access-mode-env BOOLEAN Limit content to just that available in the host's or activation key's content view version and lifecycle environment. --enabled BOOLEAN If true, only return repository sets that have been enabled. Defaults to false --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id NUMBER Id of the host --name VALUE Repository set name to search on --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER ID of a product to list repository sets from --search VALUE Search string --with-active-subscription BOOLEAN If true, only return repository sets that are associated with an active subscriptions --with-custom BOOLEAN If true, return custom repository sets along with redhat repos -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Type | x | x | Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: content_label string content_type string enabled_by_default Values: true, false label string name string path string product_id integer product_name string", "Usage: hammer role [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: clone Clone a role create Create a role delete, destroy Delete a role filters List all filters info, show Show a role list, index List all roles update Update a role Options: -h, --help Print help", "Usage: hammer role clone [OPTIONS] Options: --description VALUE Role description --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer role create [OPTIONS] Options: --description VALUE Role description --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer role <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE User role name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer role filters [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE User role id --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE User role name --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Resource type | x | x | Search | x | x | Unlimited? | x | x | Override? | x | x | Role | x | x | Permissions | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer role <info|show> [OPTIONS] Options: --description VALUE --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE User role name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Builtin | x | x | Description | x | x | Locations/ | x | x | Organizations/ | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer role <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------|-----|---------|----- Id | x | x | x Name | x | x | x Builtin | x | x | --------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: builtin Values: true, false description text name string permission string", "Usage: hammer role update [OPTIONS] Options: --description VALUE Role description --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: bulk-upload Upload scap contents in bulk create Create SCAP content delete, destroy Deletes an SCAP content download Download an SCAP content as XML info, show Show an SCAP content list, index List SCAP contents update Update an SCAP content Options: -h, --help Print help", "Usage: hammer scap-content bulk-upload [OPTIONS] Options: --directory VALUE Directory to upload when using \"directory\" upload type --files LIST File paths to upload when using \"files\" upload type --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --type ENUM Type of the upload Possible value(s): 'files', 'directory', 'default' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content create [OPTIONS] Options: --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --original-filename VALUE Original file name of the XML file --scap-file FILE SCAP content file --title VALUE SCAP content name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --title VALUE SCAP content title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content download [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved --title VALUE SCAP content title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --title VALUE SCAP content title -h, --help Print help Predefined field sets: ---------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------------------|-----|---------|----- Id | x | x | x Title | x | x | x Digest | x | x | Created at | x | x | Original filename | x | x | Scap content profiles/id | x | x | Scap content profiles/profile id | x | x | Scap content profiles/title | x | x | Locations/ | x | x | Organizations/ | x | x | ---------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Title | x | x | x Digest | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: created_at datetime filename string location string location_id integer organization string organization_id integer title string", "Usage: hammer scap-content update [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --new-title VALUE SCAP content name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --original-filename VALUE Original file name of the XML file --scap-file FILE SCAP content file --title VALUE SCAP content name -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer scap-content-profile [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: list, index List SCAP content profiles Options: -h, --help Print help", "Usage: hammer scap-content-profile <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: --------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------|-----|---------|----- Id | x | x | x Title | x | x | Profile id | x | x | Scap content id | x | x | Scap content title | x | x | Tailoring file id | x | x | Tailoring file name | x | x | x --------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: profile_id string title string", "Usage: hammer settings [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show a setting list, index List all settings set Update a setting Options: -h, --help Print help", "Usage: hammer settings <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Setting name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Category | x | x | Settings type | x | x | Value | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer settings <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Full name | x | x | Value | x | x | Description | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: description text name string", "Usage: hammer settings set [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Setting name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --value VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer shell [OPTIONS] Options: -h, --help Print help", "Usage: hammer simple-content-access [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: disable Disable simple content access for a manifest enable Enable simple content access for a manifest Options: -h, --help Print help Unfortunately the server does not support such operation.", "Usage: hammer simple-content-access disable [OPTIONS] Options: --async Do not wait for the task --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer simple-content-access enable [OPTIONS] Options: --async Do not wait for the task --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer srpm [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show SRPM details list, index List srpms Options: -h, --help Print help", "Usage: hammer srpm <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE SRPM details identifier --name VALUE Name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Version | x | x | Architecture | x | x | Epoch | x | x | Release | x | x | Filename | x | x | Description | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer srpm <list|index> [OPTIONS] Options: --content-view VALUE Content view name to search by --content-view-id NUMBER Content view numeric identifier --content-view-version VALUE Content view version number --content-view-version-id NUMBER Content View Version identifier --environment VALUE Lifecycle environment name to search by (--environment is deprecated: Use --lifecycle-environment instead) --environment-id NUMBER (--environment-id is deprecated: Use --lifecycle-environment-id instead) --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --lifecycle-environment VALUE Lifecycle environment name to search by --lifecycle-environment-id NUMBER Environment identifier --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization identifier --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --product VALUE Product name to search by --product-id NUMBER Product numeric identifier --repository VALUE Repository name to search by --repository-id NUMBER Repository identifier --search VALUE Search string -h, --help Print help Predefined field sets: ---------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------|-----|---------|----- Id | x | x | x Name | x | x | x Filename | x | x | ---------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer status [OPTIONS] [SUBCOMMAND] [ARG] Parameters: [ARG] ... Subcommand arguments [SUBCOMMAND] Subcommand (default: \"foreman\") Subcommands: foreman Shows status and version information of Satellite system and it's subcomponents katello Shows version information Options: -h, --help Print help", "Usage: hammer status foreman [OPTIONS] Options: -h, --help Print help", "Usage: hammer status katello [OPTIONS] Options: -h, --help Print help", "Usage: hammer subnet [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a subnet delete, destroy Delete a subnet delete-parameter Delete parameter for a subnet info, show Show a subnet list, index List of subnets set-parameter Create or update parameter for a subnet update Update a subnet Options: -h, --help Print help", "Usage: hammer subnet create [OPTIONS] Options: --bmc VALUE BMC Proxy to use within this subnet --bmc-id NUMBER BMC Capsule ID to use within this subnet --boot-mode ENUM Default boot mode for interfaces assigned to this subnet. Possible value(s): 'Static', 'DHCP' --description VALUE Subnet description --dhcp VALUE DHCP Proxy to use within this subnet --dhcp-id NUMBER DHCP Capsule ID to use within this subnet --discovery-id NUMBER ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts --dns VALUE DNS Proxy to use within this subnet --dns-id NUMBER DNS Capsule ID to use within this subnet --dns-primary VALUE Primary DNS for this subnet --dns-secondary VALUE Secondary DNS for this subnet --domain-ids LIST Domains in which this subnet is part --domains LIST --externalipam-group VALUE External IPAM group - only relevant when IPAM is set to external --externalipam-id NUMBER External IPAM Capsule ID to use within this subnet --from VALUE Starting IP Address for IP auto suggestion --gateway VALUE Subnet gateway --httpboot-id NUMBER HTTPBoot Capsule ID to use within this subnet --ipam ENUM IP Address auto suggestion mode for this subnet. Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --mask VALUE Netmask for this subnet --mtu NUMBER MTU for this subnet --name VALUE Subnet name --network VALUE Subnet network --network-type ENUM Type or protocol, IPv4 or IPv6, defaults to IPv4 Possible value(s): 'IPv4', 'IPv6' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --prefix VALUE Network prefix in CIDR notation (e.g. 64) for this subnet --remote-execution-proxy-ids LIST List of Capsule IDs to be used for remote execution --template-id NUMBER Template HTTP(S) Capsule ID to use within this subnet --tftp VALUE TFTP Proxy to use within this subnet --tftp-id NUMBER TFTP Capsule ID to use within this subnet --to VALUE Ending IP Address for IP auto suggestion --vlanid VALUE VLAN ID for this subnet -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subnet <delete|destroy> [OPTIONS] Options: --id NUMBER Subnet numeric identifier --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Subnet name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subnet delete-parameter [OPTIONS] Options: --name VALUE Parameter name --subnet VALUE Subnet name --subnet-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subnet <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Subnet name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --show-hidden-parameters BOOLEAN Display hidden parameter values -h, --help Print help Predefined field sets: ------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Protocol | x | x | Priority | x | x | Network addr | x | x | Network prefix | x | x | Network mask | x | x | Gateway addr | x | x | Primary dns | x | x | Secondary dns | x | x | Smart proxies/dns | x | x | Smart proxies/tftp | x | x | Smart proxies/dhcp | x | x | Remote execution proxies/id | x | x | Remote execution proxies/name | x | x | Ipam | x | x | Start of ip range | x | x | End of ip range | x | x | Vlan id | x | x | Mtu | x | x | Boot mode | x | x | Domains/ | x | x | Locations/ | x | x | Organizations/ | x | x | Parameters/ | x | x | ------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subnet <list|index> [OPTIONS] Options: --domain VALUE Domain name --domain-id VALUE ID of domain --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ----------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------|-----|---------|----- Id | x | x | x Name | x | x | x Network addr | x | x | Network prefix | x | x | Network mask | x | x | Vlan id | x | x | Boot mode | x | x | Gateway address | x | x | ----------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: boot_mode string dns_primary string dns_secondary string domain string gateway string ipam string location string location_id integer mask string mtu integer name text network string nic_delay integer organization string organization_id integer params string type string vlanid integer", "Usage: hammer subnet set-parameter [OPTIONS] Options: --hidden-value BOOLEAN Should the value be hidden --name VALUE Parameter name --parameter-type ENUM Type of the parameter Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json' Default: \"string\" --subnet VALUE Subnet name --subnet-id NUMBER --value VALUE Parameter value -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subnet update [OPTIONS] Options: --bmc VALUE BMC Proxy to use within this subnet --bmc-id NUMBER BMC Capsule ID to use within this subnet --boot-mode ENUM Default boot mode for interfaces assigned to this subnet. Possible value(s): 'Static', 'DHCP' --description VALUE Subnet description --dhcp VALUE DHCP Proxy to use within this subnet --dhcp-id NUMBER DHCP Capsule ID to use within this subnet --discovery-id NUMBER ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts --dns VALUE DNS Proxy to use within this subnet --dns-id NUMBER DNS Capsule ID to use within this subnet --dns-primary VALUE Primary DNS for this subnet --dns-secondary VALUE Secondary DNS for this subnet --domain-ids LIST Domains in which this subnet is part --domains LIST --externalipam-group VALUE External IPAM group - only relevant when IPAM is set to external --externalipam-id NUMBER External IPAM Capsule ID to use within this subnet --from VALUE Starting IP Address for IP auto suggestion --gateway VALUE Subnet gateway --httpboot-id NUMBER HTTPBoot Capsule ID to use within this subnet --id NUMBER Subnet numeric identifier --ipam ENUM IP Address auto suggestion mode for this subnet. Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --mask VALUE Netmask for this subnet --mtu NUMBER MTU for this subnet --name VALUE Subnet name --network VALUE Subnet network --network-type ENUM Type or protocol, IPv4 or IPv6, defaults to IPv4 Possible value(s): 'IPv4', 'IPv6' --new-name VALUE Subnet name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --prefix VALUE Network prefix in CIDR notation (e.g. 64) for this subnet --remote-execution-proxy-ids LIST List of Capsule IDs to be used for remote execution --template-id NUMBER Template HTTP(S) Capsule ID to use within this subnet --tftp VALUE TFTP Proxy to use within this subnet --tftp-id NUMBER TFTP Capsule ID to use within this subnet --to VALUE Ending IP Address for IP auto suggestion --vlanid VALUE VLAN ID for this subnet -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subscription [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: delete-manifest Delete manifest from Red Hat provider list, index List organization subscriptions manifest-history Obtain manifest history for subscriptions refresh-manifest Refresh previously imported manifest for Red Hat provider upload Upload a subscription manifest Options: -h, --help Print help", "Usage: hammer subscription delete-manifest [OPTIONS] Options: --async Do not wait for the task --organization VALUE Organization name to search by --organization-id NUMBER Organization id --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subscription <list|index> [OPTIONS] Options: --activation-key VALUE Activation key name to search by --activation-key-id VALUE Activation key ID --available-for VALUE Object to show subscriptions available for, either 'host' or 'activation_key' --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --host VALUE Host name --host-id VALUE Id of a host --match-host BOOLEAN Ignore subscriptions that are unavailable to the specified host --match-installed BOOLEAN Return subscriptions that match installed products of the specified host --name VALUE Name of the subscription --no-overlap BOOLEAN Return subscriptions which do not overlap with a currently-attached subscription --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string -h, --help Print help Predefined field sets: -----------|-----|-------- FIELDS | ALL | DEFAULT -----------|-----|-------- Id | x | x Uuid | x | x Name | x | x Type | x | x Contract | x | x Account | x | x Support | x | x Start date | x | x End date | x | x Quantity | x | x Consumed | x | x -----------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subscription manifest-history [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: ---------------|-----|-------- FIELDS | ALL | DEFAULT ---------------|-----|-------- Status | x | x Status message | x | x Time | x | x ---------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subscription refresh-manifest [OPTIONS] Options: --async Do not wait for the task --organization VALUE Organization name to search by --organization-id NUMBER Organization id --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer subscription upload [OPTIONS] Options: --async Do not wait for the task --file FILE Subscription manifest file --organization VALUE Organization name to search by --organization-id NUMBER Organization id --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer sync-plan [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a sync plan delete, destroy Destroy a sync plan info, show Show a sync plan list, index List sync plans update Update a sync plan Options: -h, --help Print help", "Usage: hammer sync-plan create [OPTIONS] Options: --cron-expression VALUE Set this when interval is custom cron --description VALUE Sync plan description --enabled BOOLEAN Enables or disables synchronization --interval VALUE How often synchronization should run --name VALUE Sync plan name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --sync-date DATETIME Start date and time for the sync plan.Time is optional, if kept blank current system time will be considered -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer sync-plan <delete|destroy> [OPTIONS] Options: --id NUMBER Sync plan numeric identifier --name VALUE Sync plan name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer sync-plan <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id NUMBER Sync plan numeric identifier --name VALUE Sync plan name to search by --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Name | x | x | x Start date | x | x | Interval | x | x | Enabled | x | x | Cron expression | x | x | Recurring logic id | x | x | Description | x | x | Created at | x | x | Updated at | x | x | Next sync | x | x | Products/id | x | x | Products/name | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer sync-plan <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --full-result BOOLEAN Whether or not to show all results --interval ENUM Filter by interval Possible value(s): 'hourly', 'daily', 'weekly', 'custom cron' --name VALUE Filter by name --order VALUE Sort field and order, eg. 'id DESC' --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --page NUMBER Page number, starting at 1 --per-page NUMBER Number of results per page to return --search VALUE Search string --sync-date VALUE Filter by sync date -h, --help Print help Predefined field sets: -------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------------|-----|---------|----- Id | x | x | x Name | x | x | x Start date | x | x | Interval | x | x | Enabled | x | x | Cron expression | x | x | Recurring logic id | x | x | -------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: enabled Values: true, false interval string name string organization_id integer", "Usage: hammer sync-plan update [OPTIONS] Options: --cron-expression VALUE Add custom cron logic for sync plan --description VALUE Sync plan description --enabled BOOLEAN Enables or disables synchronization --id NUMBER Sync plan numeric identifier --interval VALUE How often synchronization should run --name VALUE Sync plan name --new-name VALUE Sync plan name --organization VALUE Organization name to search by --organization-id NUMBER Organization ID --organization-label VALUE Organization label to search by --organization-title VALUE Organization title --sync-date DATETIME Start date and time of the synchronization -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer tailoring-file [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Tailoring file delete, destroy Deletes a Tailoring file download Download a Tailoring file as XML info, show Show a Tailoring file list, index List Tailoring files update Update a Tailoring file Options: -h, --help Print help", "Usage: hammer tailoring-file create [OPTIONS] Options: --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --name VALUE Tailoring file name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --original-filename VALUE Original file name of the XML file --scap-file FILE Tailoring file content -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer tailoring-file <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer tailoring-file download [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --name VALUE Tailoring file name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --path VALUE Path to directory where downloaded file will be saved -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer tailoring-file <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --name VALUE Tailoring file name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Created at | x | x | Original filename | x | x | Tailoring file profiles/id | x | x | Tailoring file profiles/profile id | x | x | Tailoring file profiles/title | x | x | Locations/ | x | x | Organizations/ | x | x | -----------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer tailoring-file <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: created_at datetime filename string location string location_id integer name string organization string organization_id integer", "Usage: hammer tailoring-file update [OPTIONS] Options: --id VALUE --location VALUE Name to search by --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --locations LIST --name VALUE Tailoring file name --new-name VALUE Tailoring file name --organization VALUE Name to search by --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organizations LIST --original-filename VALUE Original file name of the XML file --scap-file FILE Tailoring file content -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer task [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: info, show Show task details list, index List tasks progress Show the progress of the task resume Resume all tasks paused in error state Options: -h, --help Print help", "Usage: hammer task <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE UUID of the task --location-id NUMBER Set the current location context for the request --organization-id NUMBER Set the current organization context for the request -h, --help Print help Predefined field sets: ------------|-----|-------- FIELDS | ALL | DEFAULT ------------|-----|-------- Id | x | x Action | x | x State | x | x Result | x | x Started at | x | x Ended at | x | x Duration | x | x Owner | x | x Task errors | x | x ------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer task <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location-id NUMBER Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization-id NUMBER Set the current organization context for the request --page NUMBER Page number, starting at 1 --parent-task-id VALUE UUID of the task --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ------------|-----|-------- FIELDS | ALL | DEFAULT ------------|-----|-------- Id | x | x Action | x | x State | x | x Result | x | x Started at | x | x Ended at | x | x Duration | x | x Owner | x | x Task errors | x | x ------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer task progress [OPTIONS] Options: --id VALUE UUID of the task --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer task resume [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --search VALUE Resume tasks matching search string --task-ids LIST Resume specific tasks by ID --tasks LIST -h, --help Print help Predefined field sets: ----------------------------------------|-----|-------- FIELDS | ALL | DEFAULT ----------------------------------------|-----|-------- Total tasks found paused in error state | x | x Total tasks resumed | x | x Resumed tasks/task identifier | x | x Resumed tasks/task action | x | x Resumed tasks/task errors | x | x Total tasks failed to resume | x | x Failed tasks/task identifier | x | x Failed tasks/task action | x | x Failed tasks/task errors | x | x Total tasks skipped | x | x Skipped tasks/task identifier | x | x Skipped tasks/task action | x | x Skipped tasks/task errors | x | x ----------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-operatingsystem Associate an operating system build-pxe-default Update the default PXE menu on all configured TFTP servers clone Clone a provision template combination Manage template combinations create Create a provisioning template delete, destroy Delete a provisioning template dump View provisioning template content info, show Show provisioning template details kinds List available provisioning template kinds list, index List provisioning templates remove-operatingsystem Disassociate an operating system update Update a provisioning template Options: -h, --help Print help", "Usage: hammer template add-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Name to search by --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template build-pxe-default [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template clone [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Template name --new-name VALUE Template name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template combination [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Add a template combination delete, destroy Delete a template combination info, show Show template combination list, index List template combination update Update template combination Options: -h, --help Print help", "Usage: hammer template combination create [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id VALUE ID of config template -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template combination <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template combination <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id VALUE ID of config template -h, --help Print help Predefined field sets: ---------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------------|-----|---------|----- Id | x | x | x Provisioning template id | x | x | Provisioning template name | x | x | Hostgroup id | x | x | Hostgroup name | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | ---------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template combination <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id VALUE ID of config template -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Provisioning template | x | x | Hostgroup | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template combination update [OPTIONS] Options: --hostgroup VALUE Hostgroup name --hostgroup-id VALUE ID of host group --hostgroup-title VALUE Hostgroup title --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --provisioning-template VALUE Name to search by --provisioning-template-id VALUE ID of config template -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template create [OPTIONS] Options: --audit-comment VALUE --description VALUE --file FILE Path to a file that contains the template --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE Template name --operatingsystem-ids LIST Array of operating system IDs to associate with the template --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --type VALUE Template type. Eg. snippet, script, provision -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template dump [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ---------------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Type | x | x | Description | x | x | Locked | x | x | Operating systems/ | x | x | Locations/ | x | x | Organizations/ | x | x | Template combinations/hostgroup name | x | x | Template combinations/environment name | x | x | ---------------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template kinds [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER ID of operating system --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Type | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: default_template Values: true, false hostgroup string kind string location string location_id integer locked Values: true, false name string operatingsystem string organization string organization_id integer snippet Values: true, false supported Values: true, false template text vendor string", "Usage: hammer template remove-operatingsystem [OPTIONS] Options: --id VALUE --name VALUE Name to search by --operatingsystem VALUE Operating system title --operatingsystem-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template update [OPTIONS] Options: --audit-comment VALUE --description VALUE --file FILE Path to a file that contains the template --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE Template name --new-name VALUE Template name --operatingsystem-ids LIST Array of operating system IDs to associate with the template --operatingsystems LIST --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --type VALUE Template type. Eg. snippet, script, provision -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template-input [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a template input delete, destroy Delete a template input info, show Show template input details list, index List template inputs update Update a template input Options: -h, --help Print help", "Usage: hammer template-input create [OPTIONS] Options: --advanced BOOLEAN Input is advanced --default VALUE Default value for user input --description VALUE Input description --fact-name VALUE Fact name, used when input type is Fact value --hidden-value BOOLEAN The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords --input-type ENUM Input type Possible value(s): 'user', 'fact', 'variable' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Input name --options LIST Selectable values for user inputs --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --required BOOLEAN Input is required --resource-type ENUM For values of type search, this is the resource the value searches in Possible value(s): 'AnsibleRole', 'AnsibleVariable', 'Architecture', 'Audit', 'AuthSource', 'Bookmark', 'ComputeProfile', 'ComputeResource', 'ConfigReport', 'DiscoveryRule', 'Domain', 'ExternalUsergroup', 'FactValue', 'Filter', 'ForemanOpenscap::ArfReport', 'ForemanOpenscap::OvalContent', 'ForemanOpenscap::OvalPolicy', 'ForemanOpenscap::Policy', 'ForemanOpenscap::ScapContent', 'ForemanOpenscap::TailoringFile', 'ForemanTasks::RecurringLogic', 'ForemanTasks::Task', 'ForemanVirtWhoConfigure::Config', 'Host', 'Hostgroup', 'HttpProxy', 'Image', 'InsightsHit', 'JobInvocation', 'JobTemplate', 'Katello::ActivationKey', 'Katello::ContentCredential', 'Katello::ContentView', 'Katello::HostCollection', 'Katello::KTEnvironment', 'Katello::Product', 'Katello::Subscription', 'Katello::SyncPlan', 'KeyPair', 'Location', 'MailNotification', 'Medium', 'Model', 'Operatingsystem', 'Organization', 'Parameter', 'PersonalAccessToken', 'ProvisioningTemplate', 'Ptable', 'Realm', 'RemoteExecutionFeature', 'Report', 'ReportTemplate', 'Role', 'Setting', 'SmartProxy', 'SshKey', 'Subnet', 'Template', 'TemplateInvocation', 'User', 'Usergroup', 'Webhook', 'WebhookTemplate' --template-id VALUE --value-type ENUM Value type, defaults to plain Possible value(s): 'plain', 'search', 'date', 'resource' --variable-name VALUE Variable name, used when input type is Variable -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template-input <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template-input <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --template-id VALUE -h, --help Print help Predefined field sets: ----------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------|-----|---------|----- Id | x | x | x Name | x | x | x Input type | x | x | Fact name | x | x | Variable name | x | x | Puppet parameter name | x | x | Options | x | x | Default value | x | x | ----------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer template-input <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --template-id VALUE -h, --help Print help Predefined field sets: -----------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------|-----|---------|----- Id | x | x | x Name | x | x | x Input type | x | x | -----------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: input_type string name string", "Usage: hammer template-input update [OPTIONS] Options: --advanced BOOLEAN Input is advanced --default VALUE Default value for user input --description VALUE Input description --fact-name VALUE Fact name, used when input type is Fact value --hidden-value BOOLEAN The value contains sensitive information and shouldn not be normally visible, useful e.g. for passwords --id VALUE --input-type ENUM Input type Possible value(s): 'user', 'fact', 'variable' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Input name --new-name VALUE Input name --options LIST Selectable values for user inputs --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --required BOOLEAN Input is required --resource-type ENUM For values of type search, this is the resource the value searches in Possible value(s): 'AnsibleRole', 'AnsibleVariable', 'Architecture', 'Audit', 'AuthSource', 'Bookmark', 'ComputeProfile', 'ComputeResource', 'ConfigReport', 'DiscoveryRule', 'Domain', 'ExternalUsergroup', 'FactValue', 'Filter', 'ForemanOpenscap::ArfReport', 'ForemanOpenscap::OvalContent', 'ForemanOpenscap::OvalPolicy', 'ForemanOpenscap::Policy', 'ForemanOpenscap::ScapContent', 'ForemanOpenscap::TailoringFile', 'ForemanTasks::RecurringLogic', 'ForemanTasks::Task', 'ForemanVirtWhoConfigure::Config', 'Host', 'Hostgroup', 'HttpProxy', 'Image', 'InsightsHit', 'JobInvocation', 'JobTemplate', 'Katello::ActivationKey', 'Katello::ContentCredential', 'Katello::ContentView', 'Katello::HostCollection', 'Katello::KTEnvironment', 'Katello::Product', 'Katello::Subscription', 'Katello::SyncPlan', 'KeyPair', 'Location', 'MailNotification', 'Medium', 'Model', 'Operatingsystem', 'Organization', 'Parameter', 'PersonalAccessToken', 'ProvisioningTemplate', 'Ptable', 'Realm', 'RemoteExecutionFeature', 'Report', 'ReportTemplate', 'Role', 'Setting', 'SmartProxy', 'SshKey', 'Subnet', 'Template', 'TemplateInvocation', 'User', 'Usergroup', 'Webhook', 'WebhookTemplate' --template-id VALUE --value-type ENUM Value type, defaults to plain Possible value(s): 'plain', 'search', 'date', 'resource' --variable-name VALUE Variable name, used when input type is Variable -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: access-token Managing personal access tokens add-role Assign a user role create Create a user delete, destroy Delete a user info, show Show a user list, index List all users mail-notification Managing personal mail notifications remove-role Remove a user role ssh-keys Managing User SSH Keys. update Update a user Options: -h, --help Print help", "Usage: hammer user access-token [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Personal Access Token for a user info, show Show a Personal Access Token for a user list, index List all Personal Access Tokens for a user revoke Revoke a Personal Access Token for a user Options: -h, --help Print help", "Usage: hammer user access-token create [OPTIONS] Options: --expires-at VALUE Expiry Date --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user access-token <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Predefined field sets: -------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------------|-----|---------|----- Id | x | x | x Name | x | x | x Active | x | x | Expires at | x | x | Created at | x | x | Last used at | x | x | -------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user access-token <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Predefined field sets: -----------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------|-----|---------|----- Id | x | x | x Name | x | x | x Active | x | x | Expires at | x | x | -----------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string user_id integer", "Usage: hammer user access-token revoke [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user add-role [OPTIONS] Options: --id VALUE --login VALUE User's login to search by --role VALUE User role name --role-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user create [OPTIONS] Options: --admin BOOLEAN Is an admin account --ask-password BOOLEAN --auth-source VALUE Name to search by --auth-source-id NUMBER --default-location VALUE Default location name --default-location-id NUMBER --default-organization VALUE Default organization name --default-organization-id NUMBER --description VALUE --disabled BOOLEAN --firstname VALUE --lastname VALUE --locale ENUM User's preferred locale Possible value(s): 'ca', 'cs_CZ', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --login VALUE --mail VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --password VALUE Required unless user is in an external authentication source --role-ids LIST --roles LIST --timezone ENUM User's timezone Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)', 'Central America', 'Central Time (US & Canada)', 'Guadalajara', 'Mexico City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US & Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)', 'Caracas', 'Georgetown', 'La Paz', 'Puerto Rico', 'Santiago', 'Newfoundland', 'Brasilia', 'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa', 'Samoa', 'Tokelau Is.' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --login VALUE User's login to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --login VALUE User's login to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------|-----|---------|----- Id | x | x | x Login | x | x | x Name | x | x | Email | x | x | Admin | x | x | Disabled | x | x | Last login | x | x | Authorized by | x | x | Effective admin | x | x | Locale | x | x | Timezone | x | x | Description | x | x | Default organization | x | x | Default location | x | x | Roles/ | x | x | User groups/usergroup | x | x | User groups/id | x | x | User groups/roles/ | x | x | Inherited user groups/usergroup | x | x | Inherited user groups/id | x | x | Inherited user groups/roles/ | x | x | Locations/ | x | x | Organizations/ | x | x | Created at | x | x | Updated at | x | x | --------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user <list|index> [OPTIONS] Options: --auth-source-ldap VALUE Name to search by --auth-source-ldap-id VALUE ID of LDAP authentication source --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Scope by locations --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Scope by organizations --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --role VALUE User role name --role-id VALUE ID of role --search VALUE Filter results --user-group VALUE Name to search by --user-group-id VALUE ID of user group -h, --help Print help Predefined field sets: --------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------|-----|---------|----- Id | x | x | x Login | x | x | x Name | x | x | Email | x | x | Admin | x | x | Disabled | x | x | Last login | x | x | Authorized by | x | x | --------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: admin Values: true, false auth_source string auth_source_type string description text disabled Values: true, false firstname string last_login_on datetime lastname string location string location_id integer login string mail string organization string organization_id integer role string role_id integer usergroup string", "Usage: hammer user mail-notification [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add Add an email notification for a user list, index List all email notifications for a user remove Remove an email notification for a user update Update an email notification for a user Options: -h, --help Print help", "Usage: hammer user mail-notification add [OPTIONS] Options: --interval VALUE Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mail-notification VALUE Name to search by --mail-notification-id NUMBER --mail-query VALUE Relevant only for audit summary notification --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --subscription VALUE Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state --user VALUE User's login to search by --user-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user mail-notification <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | Name | x | x | x Description | x | x | Interval | x | x | Mail query | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user mail-notification remove [OPTIONS] Options: --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mail-notification VALUE Name to search by --mail-notification-id NUMBER --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user mail-notification update [OPTIONS] Options: --interval VALUE Mail notification interval option, e.g. Daily, Weekly or Monthly. Required for summary notification --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --mail-notification VALUE Name to search by --mail-notification-id NUMBER --mail-query VALUE Relevant only for audit summary notification --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --subscription VALUE Mail notification subscription option, e.g. Subscribe, Subscribe to my hosts or Subscribe to all hosts. Required for host built and config error state --user VALUE User's login to search by --user-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user remove-role [OPTIONS] Options: --id VALUE --login VALUE User's login to search by --role VALUE User role name --role-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user ssh-keys [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add Add an SSH key for a user delete, destroy Delete an SSH key for a user info, show Show an SSH key from a user list, index List all SSH keys for a user Options: -h, --help Print help", "Usage: hammer user ssh-keys add [OPTIONS] Options: --key VALUE Public SSH key --key-file FILE Path to a SSH public key --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user ssh-keys <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user ssh-keys <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Fingerprint | x | x | Length | x | x | Created at | x | x | Public key | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user ssh-keys <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results --user VALUE User's login to search by --user-id VALUE ID of the user -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Fingerprint | x | x | Length | x | x | Created at | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string user_id integer", "Usage: hammer user update [OPTIONS] Options: --admin BOOLEAN Is an admin account --ask-password BOOLEAN --auth-source VALUE Name to search by --auth-source-id NUMBER --current-password VALUE Required when user want to change own password --default-location VALUE Default location name --default-location-id NUMBER --default-organization VALUE Default organization name --default-organization-id NUMBER --description VALUE --disabled BOOLEAN --firstname VALUE --id VALUE --lastname VALUE --locale ENUM User's preferred locale Possible value(s): 'ca', 'cs_CZ', 'de', 'en', 'en_GB', 'es', 'fr', 'gl', 'it', 'ja', 'ko', 'nl_NL', 'pl', 'pt_BR', 'ru', 'sv_SE', 'zh_CN', 'zh_TW' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --login VALUE --mail VALUE --new-login VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --password VALUE Required unless user is in an external authentication source --role-ids LIST --roles LIST --timezone ENUM User's timezone Possible value(s): 'International Date Line West', 'American Samoa', 'Midway Island', 'Hawaii', 'Alaska', 'Pacific Time (US & Canada)', 'Tijuana', 'Arizona', 'Chihuahua', 'Mazatlan', 'Mountain Time (US & Canada)', 'Central America', 'Central Time (US & Canada)', 'Guadalajara', 'Mexico City', 'Monterrey', 'Saskatchewan', 'Bogota', 'Eastern Time (US & Canada)', 'Indiana (East)', 'Lima', 'Quito', 'Atlantic Time (Canada)', 'Caracas', 'Georgetown', 'La Paz', 'Puerto Rico', 'Santiago', 'Newfoundland', 'Brasilia', 'Buenos Aires', 'Greenland', 'Montevideo', 'Mid-Atlantic', 'Azores', 'Cape Verde Is.', 'Casablanca', 'Dublin', 'Edinburgh', 'Lisbon', 'London', 'Monrovia', 'UTC', 'Amsterdam', 'Belgrade', 'Berlin', 'Bern', 'Bratislava', 'Brussels', 'Budapest', 'Copenhagen', 'Ljubljana', 'Madrid', 'Paris', 'Prague', 'Rome', 'Sarajevo', 'Skopje', 'Stockholm', 'Vienna', 'Warsaw', 'West Central Africa', 'Zagreb', 'Zurich', 'Athens', 'Bucharest', 'Cairo', 'Harare', 'Helsinki', 'Jerusalem', 'Kaliningrad', 'Kyiv', 'Pretoria', 'Riga', 'Sofia', 'Tallinn', 'Vilnius', 'Baghdad', 'Istanbul', 'Kuwait', 'Minsk', 'Moscow', 'Nairobi', 'Riyadh', 'St. Petersburg', 'Volgograd', 'Tehran', 'Abu Dhabi', 'Baku', 'Muscat', 'Samara', 'Tbilisi', 'Yerevan', 'Kabul', 'Ekaterinburg', 'Islamabad', 'Karachi', 'Tashkent', 'Chennai', 'Kolkata', 'Mumbai', 'New Delhi', 'Sri Jayawardenepura', 'Kathmandu', 'Almaty', 'Astana', 'Dhaka', 'Urumqi', 'Rangoon', 'Bangkok', 'Hanoi', 'Jakarta', 'Krasnoyarsk', 'Novosibirsk', 'Beijing', 'Chongqing', 'Hong Kong', 'Irkutsk', 'Kuala Lumpur', 'Perth', 'Singapore', 'Taipei', 'Ulaanbaatar', 'Osaka', 'Sapporo', 'Seoul', 'Tokyo', 'Yakutsk', 'Adelaide', 'Darwin', 'Brisbane', 'Canberra', 'Guam', 'Hobart', 'Melbourne', 'Port Moresby', 'Sydney', 'Vladivostok', 'Magadan', 'New Caledonia', 'Solomon Is.', 'Srednekolymsk', 'Auckland', 'Fiji', 'Kamchatka', 'Marshall Is.', 'Wellington', 'Chatham Is.', 'Nuku'alofa', 'Samoa', 'Tokelau Is.' -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: add-role Assign a user role add-user Associate an user add-user-group Associate an user group create Create a user group delete, destroy Delete a user group external View and manage user group's external user groups info, show Show a user group list, index List all user groups remove-role Remove a user role remove-user Disassociate an user remove-user-group Disassociate an user group update Update a user group Options: -h, --help Print help", "Usage: hammer user-group add-role [OPTIONS] Options: --id VALUE --name VALUE Name to search by --role VALUE User role name --role-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group add-user [OPTIONS] Options: --id VALUE --name VALUE Name to search by --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group add-user-group [OPTIONS] Options: --id VALUE --name VALUE Name to search by --user-group VALUE Name to search by --user-group-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group create [OPTIONS] Options: --admin BOOLEAN Is an admin user group, can be modified by admins only --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --role-ids LIST --roles LIST --user-group-ids LIST --user-groups LIST --user-ids LIST --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create an external user group linked to a user group delete, destroy Delete an external user group info, show Show an external user group for user group list, index List all external user groups for user group refresh Refresh external user group update Update external user group Options: -h, --help Print help", "Usage: hammer user-group external create [OPTIONS] Options: --auth-source VALUE Name to search by --auth-source-id NUMBER ID of linked authentication source --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE External user group name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external <delete|destroy> [OPTIONS] Options: --id VALUE ID or name external user group --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE ID or name of external user group --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Auth source | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Id | x | x | x Name | x | x | x Auth source | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external refresh [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE ID or name of external user group --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Predefined field sets: ------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ------------|-----|---------|----- Name | x | x | x Auth source | x | x | ------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group external update [OPTIONS] Options: --auth-source VALUE Name to search by --auth-source-id NUMBER ID of linked authentication source --id VALUE ID or name of external user group --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE External user group name --new-name VALUE External user group name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --user-group VALUE Name to search by --user-group-id VALUE ID or name of user group -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: --------------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN --------------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Admin | x | x | Users/ | x | x | User groups/usergroup | x | x | User groups/id | x | x | User groups/roles/ | x | x | Inherited user groups/usergroup | x | x | Inherited user groups/id | x | x | Inherited user groups/roles/ | x | x | External user groups/ | x | x | Roles/ | x | x | Created at | x | x | Updated at | x | x | --------------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x Admin | x | x | -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: name string role string role_id integer", "Usage: hammer user-group remove-role [OPTIONS] Options: --id VALUE --name VALUE Name to search by --role VALUE User role name --role-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group remove-user [OPTIONS] Options: --id VALUE --name VALUE Name to search by --user VALUE User's login to search by --user-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group remove-user-group [OPTIONS] Options: --id VALUE --name VALUE Name to search by --user-group VALUE Name to search by --user-group-id NUMBER -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer user-group update [OPTIONS] Options: --admin BOOLEAN Is an admin user group, can be modified by admins only --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --role-ids LIST --roles LIST --user-group-ids LIST --user-groups LIST --user-ids LIST --users LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a virt-who configuration delete, destroy Delete a virt-who configuration deploy Download and execute script for the specified virt-who configuration fetch Renders a deploy script for the specified virt-who configuration info, show Show a virt-who configuration list, index List of virt-who configurations update Update a virt-who configuration Options: -h, --help Print help", "Usage: hammer virt-who-config create [OPTIONS] Options: --ahv-internal-debug BOOLEAN Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled --ahv-update-interval NUMBER The frequency of VM-to-host mapping updates for AHV(in seconds) --blacklist VALUE Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma. --debug BOOLEAN Enable debugging output --exclude-host-parents VALUE Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end. --filter-host-parents VALUE Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end. --filtering-mode ENUM Hypervisor filtering mode Possible value(s): 'none', 'whitelist', 'blacklist' --http-proxy VALUE Name to search by --http-proxy-id NUMBER HTTP Proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers. --hypervisor-id ENUM Specifies how the hypervisor will be identified. Possible value(s): 'hostname', 'uuid', 'hwuuid' --hypervisor-password VALUE Hypervisor password, required for all hypervisor types except for libvirt/kubevirt. --hypervisor-server VALUE Fully qualified host name or IP address of the hypervisor --hypervisor-type ENUM Hypervisor type Possible value(s): 'esx', 'hyperv', 'libvirt', 'kubevirt', 'ahv' --hypervisor-username VALUE Account name by which virt-who is to connect to the hypervisor. --interval ENUM Configuration interval in minutes Possible value(s): '60', '120', '240', '480', '720', '1440', '2880', '4320' --kubeconfig-path VALUE Configuration file containing details about how to connect to the cluster and authentication details. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Configuration name --no-proxy VALUE Ignore Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore Capsule settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses. --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --prism-flavor ENUM Select the Prism flavor you are connecting to Possible value(s): 'central', 'element' --satellite-url VALUE Satellite server FQDN --whitelist VALUE Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config <delete|destroy> [OPTIONS] Options: --id NUMBER Configuration numeric identifier --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config deploy [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config fetch [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help -o, --output VALUE File where the script will be written Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -----------------------------------------|-----|-------- FIELDS | ALL | DEFAULT -----------------------------------------|-----|-------- General information/id | x | x General information/name | x | x General information/hypervisor type | x | x General information/hypervisor server | x | x General information/hypervisor username | x | x General information/configuration file | x | x General information/ahv prism flavor | x | x General information/ahv update frequency | x | x General information/enable ahv debug | x | x General information/status | x | x Schedule/interval | x | x Schedule/last report at | x | x Connection/satellite server | x | x Connection/hypervisor id | x | x Connection/filtering | x | x Connection/excluded hosts | x | x Connection/filtered hosts | x | x Connection/filter host parents | x | x Connection/exclude host parents | x | x Connection/debug mode | x | x Connection/ignore proxy | x | x Http proxy/http proxy id | x | x Http proxy/http proxy name | x | x Http proxy/http proxy url | x | x Locations/ | x | x Organizations/ | x | x -----------------------------------------|-----|-------- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: ---------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ---------------|-----|---------|----- Id | x | x | x Name | x | x | x Interval | x | x | Status | x | x | Last report at | x | x | ---------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer virt-who-config update [OPTIONS] Options: --ahv-internal-debug BOOLEAN Option Enable debugging output is required to enable AHV internal debug. It provides extra AHV debug information when both options are enabled --ahv-update-interval NUMBER The frequency of VM-to-host mapping updates for AHV(in seconds) --blacklist VALUE Hypervisor blacklist, applicable only when filtering mode is set to 2. Wildcards and regular expressions are supported, multiple records must be separated by comma. --debug BOOLEAN Enable debugging output --exclude-host-parents VALUE Applicable only for esx provider type. Hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will NOT be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end. --filter-host-parents VALUE Applicable only for esx provider type. Only hosts which parent (usually ComputeResource) name is specified in comma-separated list in this option will be reported. Wildcards and regular expressions are supported, multiple records must be separated by comma. Put the value into the double-quotes if it contains special characters like comma. All new line characters will be removed in resulting configuration file, white spaces are removed from beginning and end. --filtering-mode ENUM Hypervisor filtering mode Possible value(s): 'none', 'whitelist', 'blacklist' --http-proxy VALUE Name to search by --http-proxy-id NUMBER HTTP Proxy that should be used for communication between the server on which virt-who is running and the hypervisors and virtualization managers. --hypervisor-id ENUM Specifies how the hypervisor will be identified. Possible value(s): 'hostname', 'uuid', 'hwuuid' --hypervisor-password VALUE Hypervisor password, required for all hypervisor types except for libvirt/kubevirt. --hypervisor-server VALUE Fully qualified host name or IP address of the hypervisor --hypervisor-type ENUM Hypervisor type Possible value(s): 'esx', 'hyperv', 'libvirt', 'kubevirt', 'ahv' --hypervisor-username VALUE Account name by which virt-who is to connect to the hypervisor. --id NUMBER Configuration numeric identifier --interval ENUM Configuration interval in minutes Possible value(s): '60', '120', '240', '480', '720', '1440', '2880', '4320' --kubeconfig-path VALUE Configuration file containing details about how to connect to the cluster and authentication details. --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Configuration name --new-name VALUE Configuration name --no-proxy VALUE Ignore Proxy. A comma-separated list of hostnames or domains or ip addresses to ignore Capsule settings for. Optionally this may be set to * to bypass proxy settings for all hostnames domains or ip addresses. --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --prism-flavor ENUM Select the Prism flavor you are connecting to Possible value(s): 'central', 'element' --satellite-url VALUE Satellite server FQDN --whitelist VALUE Hypervisor whitelist, applicable only when filtering mode is set to 1. Wildcards and regular expressions are supported, multiple records must be separated by comma. -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: create Create a Webhook delete, destroy Delete a Webhook info, show Show Webhook details list, index List Webhooks update Update a Webhook Options: -h, --help Print help", "Usage: hammer webhook create [OPTIONS] Options: --enabled BOOLEAN --event ENUM Possible value(s): 'actions.katello.content_view.promote_succeeded', 'actions.katello.content_view.publish_succeeded', 'actions.katello.repository.sync_succeeded', 'actions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded', 'actions.remote_execution.run_host_job_ansible_enable_web_console_succeeded', 'actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded', 'actions.remote_execution.run_host_job_ansible_run_host_succeeded', 'actions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded', 'actions.remote_execution.run_host_job_ansible_run_playbook_succeeded', 'actions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded', 'actions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded', 'actions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded', 'actions.remote_execution.run_host_job_katello_errata_install_succeeded', 'actions.remote_execution.run_host_job_katello_group_install_succeeded', 'actions.remote_execution.run_host_job_katello_group_remove_succeeded', 'actions.remote_execution.run_host_job_katello_group_update_succeeded', 'actions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded', 'actions.remote_execution.run_host_job_katello_module_stream_action_succeeded', 'actions.remote_execution.run_host_job_katello_package_install_succeeded', 'actions.remote_execution.run_host_job_katello_package_remove_succeeded', 'actions.remote_execution.run_host_job_katello_package_update_succeeded', 'actions.remote_execution.run_host_job_katello_service_restart_succeeded', 'actions.remote_execution.run_host_job_leapp_preupgrade_succeeded', 'actions.remote_execution.run_host_job_leapp_remediation_plan_succeeded', 'actions.remote_execution.run_host_job_leapp_upgrade_succeeded', 'actions.remote_execution.run_host_job_puppet_run_host_succeeded', 'actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded', 'actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded', 'actions.remote_execution.run_host_job_succeeded', 'build_entered', 'build_exited', 'content_view_created', 'content_view_destroyed', 'content_view_updated', 'domain_created', 'domain_destroyed', 'domain_updated', 'host_created', 'host_destroyed', 'host_updated', 'hostgroup_created', 'hostgroup_destroyed', 'hostgroup_updated', 'model_created', 'model_destroyed', 'model_updated', 'status_changed', 'subnet_created', 'subnet_destroyed', 'subnet_updated', 'user_created', 'user_destroyed', 'user_updated' --http-content-type VALUE --http-method ENUM Possible value(s): 'POST', 'GET', 'PUT', 'DELETE', 'PATCH' --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --proxy-authorization BOOLEAN Authorize with Satellite client certificate and validate capsule CA from Settings --target-url VALUE --user VALUE --verify-ssl BOOLEAN --webhook-template VALUE Name to search by --webhook-template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: -------------------------------|------------|-----|---------|----- FIELDS | ADDITIONAL | ALL | DEFAULT | THIN -------------------------------|------------|-----|---------|----- Id | | x | x | x Name | | x | x | x Target url | | x | x | Enabled | | x | x | Event | | x | x | Http method | | x | x | Http content type | | x | x | Webhook template | | x | x | User | x | x | | Verify ssl | x | x | | X509 certification authorities | x | x | | Http headers/ | x | x | | Created at | | x | x | Updated at | | x | x | -------------------------------|------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -----------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -----------|-----|---------|----- Id | x | x | x Name | x | x | x Target url | x | x | Enabled | x | x | -----------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: enabled Values: true, false name string target_url string", "Usage: hammer webhook update [OPTIONS] Options: --enabled BOOLEAN --event ENUM Possible value(s): 'actions.katello.content_view.promote_succeeded', 'actions.katello.content_view.publish_succeeded', 'actions.katello.repository.sync_succeeded', 'actions.remote_execution.run_host_job_ansible_configure_cloud_connector_succeeded', 'actions.remote_execution.run_host_job_ansible_enable_web_console_succeeded', 'actions.remote_execution.run_host_job_ansible_run_capsule_upgrade_succeeded', 'actions.remote_execution.run_host_job_ansible_run_host_succeeded', 'actions.remote_execution.run_host_job_ansible_run_insights_plan_succeeded', 'actions.remote_execution.run_host_job_ansible_run_playbook_succeeded', 'actions.remote_execution.run_host_job_foreman_openscap_run_oval_scans_succeeded', 'actions.remote_execution.run_host_job_foreman_openscap_run_scans_succeeded', 'actions.remote_execution.run_host_job_katello_errata_install_by_search_succeeded', 'actions.remote_execution.run_host_job_katello_errata_install_succeeded', 'actions.remote_execution.run_host_job_katello_group_install_succeeded', 'actions.remote_execution.run_host_job_katello_group_remove_succeeded', 'actions.remote_execution.run_host_job_katello_group_update_succeeded', 'actions.remote_execution.run_host_job_katello_host_tracer_resolve_succeeded', 'actions.remote_execution.run_host_job_katello_module_stream_action_succeeded', 'actions.remote_execution.run_host_job_katello_package_install_succeeded', 'actions.remote_execution.run_host_job_katello_package_remove_succeeded', 'actions.remote_execution.run_host_job_katello_package_update_succeeded', 'actions.remote_execution.run_host_job_katello_service_restart_succeeded', 'actions.remote_execution.run_host_job_leapp_preupgrade_succeeded', 'actions.remote_execution.run_host_job_leapp_remediation_plan_succeeded', 'actions.remote_execution.run_host_job_leapp_upgrade_succeeded', 'actions.remote_execution.run_host_job_puppet_run_host_succeeded', 'actions.remote_execution.run_host_job_rh_cloud_connector_run_playbook_succeeded', 'actions.remote_execution.run_host_job_rh_cloud_remediate_hosts_succeeded', 'actions.remote_execution.run_host_job_succeeded', 'build_entered', 'build_exited', 'content_view_created', 'content_view_destroyed', 'content_view_updated', 'domain_created', 'domain_destroyed', 'domain_updated', 'host_created', 'host_destroyed', 'host_updated', 'hostgroup_created', 'hostgroup_destroyed', 'hostgroup_updated', 'model_created', 'model_destroyed', 'model_updated', 'status_changed', 'subnet_created', 'subnet_destroyed', 'subnet_updated', 'user_created', 'user_destroyed', 'user_updated' --http-content-type VALUE --http-method ENUM Possible value(s): 'POST', 'GET', 'PUT', 'DELETE', 'PATCH' --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --password VALUE --proxy-authorization BOOLEAN Authorize with Satellite client certificate and validate capsule CA from Settings --target-url VALUE --user VALUE --verify-ssl BOOLEAN --webhook-template VALUE Name to search by --webhook-template-id VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template [OPTIONS] SUBCOMMAND [ARG] Parameters: SUBCOMMAND Subcommand [ARG] ... Subcommand arguments Subcommands: clone Clone a template create Create a webhook template delete, destroy Delete a webhook template dump View webhook template content import Import a webhook template info, show Show webhook template details list, index List webhook templates update Update a webhook template Options: -h, --help Print help", "Usage: hammer webhook-template clone [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Template name --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template create [OPTIONS] Options: --audit-comment VALUE --default BOOLEAN Whether or not the template is added automatically to new organizations and locations --description VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --snippet BOOLEAN --template VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template <delete|destroy> [OPTIONS] Options: --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template dump [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ------ FIELDS ------ Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template import [OPTIONS] Options: --associate ENUM Determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata Possible value(s): 'new', 'always', 'never' --default BOOLEAN Makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default) --file FILE Path to a file that contains the webhook template content including metadata --force BOOLEAN Use if you want update locked templates --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --lock BOOLEAN Lock imported templates (false by default) --name VALUE Template name --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template <info|show> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --name VALUE Name to search by --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request -h, --help Print help Predefined field sets: ----------------------------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN ----------------------------|-----|---------|----- Id | x | x | x Name | x | x | x Description | x | x | Locked | x | x | Default | x | x | Created at | x | x | Updated at | x | x | Locations/ | x | x | Organizations/ | x | x | Template inputs/id | x | x | Template inputs/name | x | x | Template inputs/description | x | x | Template inputs/required | x | x | Template inputs/options | x | x | ----------------------------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string", "Usage: hammer webhook-template <list|index> [OPTIONS] Options: --fields LIST Show specified fields or predefined field sets only. (See below) --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-title VALUE Set the current location context for the request --order VALUE Sort and order by a searchable field, e.g. '<field> DESC' --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-title VALUE Set the current organization context for the request --page NUMBER Page number, starting at 1 --per-page VALUE Number of results per page to return, 'all' to return all results --search VALUE Filter results -h, --help Print help Predefined field sets: -------|-----|---------|----- FIELDS | ALL | DEFAULT | THIN -------|-----|---------|----- Id | x | x | x Name | x | x | x -------|-----|---------|----- Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string Search / Order fields: default Values: true, false location string location_id integer locked Values: true, false name string organization string organization_id integer snippet Values: true, false template text", "Usage: hammer webhook-template update [OPTIONS] Options: --audit-comment VALUE --default BOOLEAN Whether or not the template is added automatically to new organizations and locations --description VALUE --id VALUE --location VALUE Set the current location context for the request --location-id NUMBER Set the current location context for the request --location-ids LIST REPLACE locations with given ids --location-title VALUE Set the current location context for the request --location-titles LIST --locations LIST --locked BOOLEAN Whether or not the template is locked for editing --name VALUE --new-name VALUE --organization VALUE Set the current organization context for the request --organization-id NUMBER Set the current organization context for the request --organization-ids LIST REPLACE organizations with given ids. --organization-title VALUE Set the current organization context for the request --organization-titles LIST --organizations LIST --snippet BOOLEAN --template VALUE -h, --help Print help Option details: Here you can find option types and the value an option can accept: BOOLEAN One of true/false, yes/no, 1/0 DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format ENUM Possible values are described in the option's description FILE Path to a file KEY_VALUE_LIST Comma-separated list of key=value. JSON is acceptable and preferred way for such parameters LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash. JSON is acceptable and preferred way for such parameters MULTIENUM Any combination of possible values described in the option's description NUMBER Numeric value. Integer SCHEMA Comma separated list of values defined by a schema. JSON is acceptable and preferred way for such parameters VALUE Value described in the option's description. Mostly simple string" ]
https://docs.redhat.com/en/documentation/red_hat_satellite/6.11/html/hammer_cli_guide/reference
Chapter 1. Administration Tools
Chapter 1. Administration Tools 1.1. Administration Tools Overview The following tools are available for you to use to administer Red Hat JBoss Data Virtualization: Management Console Management Command Line Interface (CLI) AdminShell Admin API JBoss Operations Network
null
https://docs.redhat.com/en/documentation/red_hat_jboss_data_virtualization/6.4/html/administration_and_configuration_guide/chap-administration_tools
Chapter 3. Deploying OpenShift Data Foundation Internal storage cluster
Chapter 3. Deploying OpenShift Data Foundation Internal storage cluster To deploy and verify OpenShift Data Foundation storage cluster in the internal mode, refer to your infrastructure specific deployment guides .
null
https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.16/html/deploying_multiple_openshift_data_foundation_storage_clusters/deploying-odf-internal-storage-cluster_rhodf
Chapter 10. Servers and Services
Chapter 10. Servers and Services Restored performance of 32-bit version of GMP In a update of RHEL 6.9, a performance regression was accidentally introduced to the 32-bit version of the GNU Multiple Precision Arithmetic Library (GMP) for AMD and Intel architecture. As a consequence, the 32-bit version of the GMP suffered marginally decreased performance. A fix has been deployed and GMP peformance has been restored to values. (BZ#1430873)
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.10_technical_notes/bug_fixes_servers_and_services
Chapter 1. Introducing Red Hat Satellite 6.11
Chapter 1. Introducing Red Hat Satellite 6.11 These release notes highlight major changes, enhancements, technology preview items, known issues, deprecated functionality, and removed functionality you must take into consideration when deploying this release of Red Hat Satellite 6. Notes for updates released during the support lifecycle of this Red Hat Satellite 6 release will appear in the advisory text associated with each update. 1.1. Major Changes This release of Red Hat Satellite 6 features the following major changes: Connected and Disconnected servers supported on RHEL 7 and RHEL 8 With this release, both connected and disconnected Satellite Servers and Capsule Servers are supported on RHEL 7 and RHEL 8. Support for RHEL 9 clients Red Hat Satellite 6.11 supports RHEL 9 hosts; the name of the repository for RHEL 9 is satellite-client-6-for-rhel-9-<arch>-rpms , where <arch> must be replaced by the required architecture. Upgrading Satellite Server and Capsule Server installations from RHEL 7 to RHEL 8 With Red Hat Satellite 6.11, you can upgrade your Satellite Server and Capsule Server installations from Red Hat Enterprise Linux version 7 to version 8 in two different ways: In-place upgrade using Leapp For more details, see Upgrading Satellite to Red Hat Enterprise Linux 8 In-Place Using Leapp . Note, that the in-place upgrade has currently multiple known issues that are listed in Section 1.4, "Known issues" . Migration To migrate your Satellite Servers and Capsule Servers, create a backup of the Satellite Server or Capsule Server on the source server, and restore the backup on the new Red Hat Enterprise Linux 8 server. For more details, see Migrating Satellite to a New Red Hat Enterprise Linux System . New Hosts Page Red Hat Satellite 6.11 introduces a new Hosts page as a Technology Preview. For more information, see Section 1.3, "Technology previews" . No Support for Mixed Versions In a disconnected environment, if some of your Satellite servers are on different versions, content import and content export do not work. All of your Satellite servers must be on the same version. Product Version-Specific Maintenance Tools Beginning with this release, maintenance tools are no longer provided from a global repository. A repository specific to the product version is used instead to better identify correctly referenced repositories. The respective repository names are rhel-7-server-satellite-maintenance-6.11-rpms (for RHEL 7) and satellite-maintenance-6.11-for-rhel-8-x86_64-rpms (for RHEL 8). Puppet integration optional and disabled by default The integration of Puppet servers and Red Hat Satellite that allows you to manage hosts using Puppet inside Red Hat Satellite is now optional. If you have a fresh installation of Red Hat Satellite and want to use Puppet, you must first enable it. If you do not intend to use Puppet after your upgrade to Red Hat Satellite 6.11, you can disable it. For more information, see Managing Configurations Using Puppet Integration in Red Hat Satellite . Run Pulp 3 on Python 3.8 Pulp 3 does not function on Python 3.6. During the upgrade to Red Hat Satellite 6.11, users are upgraded to Python 3.8. Red Hat Satellite 6.11 repository changes With this release, the Satellite Client repository replaces the Satellite Tools repository. Note that the Satellite Client repository does not include the hammer packages. The Satellite Client repository includes the following packages: katello-host-tools , gofer , qpid-proton , rubygem-foreman_scap_client . Additionally, the following repositories are added or changed in Red Hat Satellite 6.11 : The Satellite-Utils repository is an option to run on the client for all supported versions of RHEL 7 and RHEL 8. The Satellite-Maintenance repository now denotes minor versions (such as Red Hat Satellite 6.11) rather than only major versions (such as Red Hat Satellite 6). Change to Capsule certificate archive The contents of the Capsule certificate archive have changed. Consequently, you must regenerate the certificate archive when upgrading a Capsule server. For more details on the regeneration, see Upgrading Capsule Servers . New default port for communication with Red Hat Subscription Management (RHSM) API on Capsule servers With this release, Capsule Servers accept communication for the RHSM API on port 443 by default. The formerly used port 8443 is now deprecated and remains open only for existing content hosts that do not get an automatic configuration update. Module-based installation on RHEL 8 With this release, module-based installation of Satellite Server and related packages on RHEL 8 is supported. 1.2. Enhancements This release of Red Hat Satellite 6 features the following enhancements: Inter-Server Synchronization improvements Red Hat Satellite 6.11 improves configuration of inter-server synchronization (ISS) between two Satellite Servers in a multi-server Satellite setup. There are different ways of using ISS: ISS Network Sync in a Disconnected Scenario ISS Export Sync in an Air-Gapped Scenario Content Publication workflow simplification With this release, the Content Views UI is updated to simplify the Content Publication workflow. You can now use the following procedures in your workflows: Create a simple Content View Publish a Content View with the Content View promoted to the Library Environment by default Add the upstream CentOS repositories to your Content View View the module streams of the repositories in your Content Views Filter Content Views to include or exclude specific packages Filter Content Views containing Yum content to include or exclude specific packages, package groups, errata, or module streams Create a new Lifecycle Environment Registration and preview templates With Red Hat Satellite 6.11, previewing a global registration template does not require the selection of a host. Additionally, you can now preview the host_init_config template on any host, not only on the managed ones. Improved behavior for configuring and running remote jobs Satellite Servers now differentiate between infrastructure (Satellite Server or Capsule Server registered as hosts) and regular hosts. As a result, Red Hat Satellite 6.11 allows for preventing users from running remote jobs on infrastructure hosts. To run remote jobs on infrastructure hosts, your user role must have the execute_jobs_on_infrastructure_hosts permission. This permission is enabled by default for the Manager , Site Manager , and Remote Execution Manager roles. If you need the execute_jobs_on_infrastructure_hosts permission, contact your administrator. Provisioning improvements With Red Hat Satellite 6.11, provisioning templates has an icon available. Simplified host content source changing Red Hat Satellite 6.11 provides the Update packages option to update all packages on the host upon registration. Modified global setting: Subscription connection enabled The content_disconnected global setting is changed to subscription_connection_enabled and is a global setting to be configured each time you utilize a disconnected Satellite Server. As a result, Satellite Server is now connected to the Red Hat Customer Portal by default, and you must manually select No by going to Admin > Settings in the Content tab if needed. Note that you cannot connect to the Red Hat Customer portal if you select No . New error signaling unsupported options in TASK-Filter In this release, you are notified if you attempt to use unsupported options in TASK-Filter. If you receive an Invalid Options error, run --help using foreman-tasks-cleanup.sh and foreman-tasks-export.sh to see the corrected execution command. Cloud Connector configuration updated With this release, the Cloud Connector configuration method is updated with a procedure to re-enable Cloud Connector. This update is applicable to Satellite Server 6.11 and later. Improved adoption of Red Hat Insights You can receive a link to the recommendation rule for each recommendation line provided by Red Hat Insights. You can also receive a Knowledgebase article link for all recommendation lines with an article available. Virt-who configuration process improvement With this release, Satellite's Virt-who configuration is enhanced. This change facilitates the configuration of virtual machine subscriptions for Nutanix AHV. For more information, see Creating a Virt-who Configuration . New Content View Versions page With this release, you can view the content types present in a Content View on the Content View Versions page. Convert2RHEL data preparation automation With Red Hat Satellite 6.11, you can use the Convert2RHEL Ansible role to automate the process of preparing the data for converting Centos and Oracle Linux servers to Red Hat Enterprise Linux. The role uploads the manifests, prepares the repositories, creates products, creates hostgroups to share the configuration across hosts, and sets up activation keys. For more information, see Converting a Host to Red Hat Enterprise Linux with Convert2RHEL . 1.3. Technology previews The following features are available as Technology Previews in Red Hat Satellite 6.11: New Hosts Page Red Hat Satellite 6.11 introduces a new Hosts page that provides host information as a Technology Preview. Plug-ins extend the page with cards and the option to provide a tab page for the plug-in. The new Hosts page allows you to rebuild, clone, or delete the host. You can reach the new Hosts page by clicking the New UI tab on the existing Host details page. You can set default behavior to display either the new Hosts page or the existing Hosts page. Set this behavior by navigating to Administer > Settings and on the General tab page, change the value of new host details The new Hosts page includes: Host details Networking information Power operations Host status management Recent jobs Recent audits Ansible Insights Job invocation wizard This release introduces a job invocation wizard in the Lab Features menu as a Technology Preview. Options from the job invocation form remain the same in the job invocation wizard, and there are also new search options. Note that the wizard is not enabled by default. You can enable it in settings by going to Administer > Settings > Show Experimental Lab . OpenShift Virtualization plugin You can provision virtual machines using the OpenShift Virtualization compute resource as a Technology Preview. 1.4. Known issues The following known issues exist in Red Hat Satellite 6.11 at this time: Trusted proxies cannot be configured using the Satellite installer If you use Capsule for host registration or provisioning, you must add the IP address of your Capsule to the list of trusted proxies on Satellite Server. However, the installer option to set the trusted proxies is not available. BZ#( 2221794 ) This issue is resolved in Satellite 6.12 and newer. Disabled Puppet with all data removed cannot be re-enabled If the Puppet plug-in was disabled with the -f, --remove-all-data argument and you attempt to enable it again, Satellite maintain fails. BZ#( 2087067 ) Information from host group is not completely inherited when provisioning a discovered host in the Satellite web UI When you provision a discovered host, after selecting a host group and trying to customize the host entry, many critical pieces of information are missing. This results in a failed deployment attempt. As a workaround, perform one of the following actions: Provision the host using hammer: For more information, see hammer discovery provision in Hammer CLI Guide . Configure discovery rules and enable auto-provisioning so that no manual intervention is required to provision a discovered host. For more information, see Creating Discovery Rules in Provisioning Hosts . BZ#( 2069324 ) RHEL 8 FIPS mode failure with foreman-discovery-image package installation When installing the foreman-discovery-image package on RHEL 8 with FIPS mode enabled, the package installation fails with the following error message: does not verify: no digest . As a workaround, extract the ISO manually using the rpm2cpio foreman-discovery-image-XYZ.rpm | cpio -idmv command. Then convert the ISO to PXE files using the following procedure: ln -snf foreman-discovery-image-XYZ.iso fdi.iso discovery-iso-to-pxe fdi.iso mkdir -p /var/lib/tftpboot/boot/fdi-image cp ./tftpboot/vmlinuz0 /var/lib/tftpboot/boot/fdi-image/vmlinuz cp ./tftpboot/initrd0.img /var/lib/tftpboot/boot/fdi-image/initrd0.img chown -R foreman-proxy:root /var/lib/tftpboot/boot/fdi-image restorecon -RFv /var/lib/tftpboot/boot/fdi-image BZ#( 2053913 ) RHEL 9 as Guest OS is not available on VMware You can select the RHEL version as the Guest OS while deploying a host with Red Hat Satellite's VMWare compute resource. While the RHEL 9 Guest OS is available as an option, it is not currently configurable via Red Hat Satellite with VMware compute resource because RHEL 9 is not yet added to the underlying VMware library. BZ#( 2057314 ) Local boot in UEFI provisioning on virtual machines defaults to "Print warning and power off" Due to issues with newer virtual hardware versions in VMware, the local boot from disk is temporarily suspended as the default boot entry for UEFI provisioning when using the PXEGrub2 default local boot template. As a result, this disrupts the automated workflow that would normally work if you use virtual hardware version 15 or lower in VMWare or other compute resources than VMware to provision virtual machines. As a workaround, force booting from disk in the global settings. In the Satellite web UI, navigate to Administer > Settings > Provisioning and set the value of Default PXE local template entry to force_local_chain_hd0 . BZ#( 2112436 ) In-place upgrades fail to run installer in environments with insufficient resources If you attempt an in-place upgrade from RHEL 7 to RHEL 8 on a Satellite Server with insufficient resources, your upgrade fails. As a workaround, run the foreman-installer --disable-system-checks command after the RHEL 8 system has booted and logs indicate the installer has not run correctly. BZ#( 2092122 ) In-place upgrades fail to resolve Ansible dependencies on RHEL 8.6 In-place upgrades from RHEL 7 to RHEL 8 fail to resolve Ansible dependencies on RHEL 8.6. To work around this issue, run the rpm -e ansible ansible-test --nodeps command prior to the in-place upgrade. This known issue was fixed in 6.11.2. BZ#( 2089303 ) Leapp utility does not properly enable the Satellite module The Leapp utility does not properly enable the Satellite module. To work around this issue, run the following commands prior to the upgrade: # subscription-manager repo-override --repo=satellite-6.11-for-rhel-8-x86_64-rpms --add=module_hotfixes:1 (for Satellite Server) # subscription-manager repo-override --repo=satellite-capsule-6.11-for-rhel-8-x86_64-rpms --add=module_hotfixes:1 (for Capsule Server) This known issue was fixed in 6.11.2. BZ#( 2091995 ) Installing the Leapp utility does not work with the foreman-protector locking plug-in As of the current release, you cannot install the Leapp utility using the yum install leapp command simultaneously with the foreman-protector locking plug-in. To install the Leapp utility under these conditions, run the satellite-maintain packages install leapp command. BZ#( 2095506 ) Host remediation issue during an upgrade to Red Hat Satellite 6.11 Remediating hosts that meet specific criteria via the Cloud Connector is not possible during the upgrade to Red Hat Satellite 6.11. The issue affects only the hosts that have at least one organization with a manifest imported from an account that is different than the account under which the Satellite Server is registered. To work around this issue, do not click the Configure Cloud Connector button in the Red Hat Hybrid Cloud Console during the upgrade to Red Hat Satellite 6.11. As a result, your systems will be upgraded to Red Hat Satellite 6.11 with the receptor-based version, where multi-account support works as expected. BZ#( 2095598 ) Provisioning of Grub 2 UEFI host fails with Capsule Servers running on RHEL 8.5 and later versions Due to changes in the grub2-efi package, the base directory where Grub 2 searches for configuration files has changed. Consequently, attempts to provision a Grub 2 UEFI host from Capsule Servers running on Red Hat Enterpise Linux (RHEL) 8.5 or later versions of RHEL 8 fail. To work around the issue, create relative symlinks in the /var/lib/tftpboot directory as follows: /var/lib/tftpboot/EFI/redhat ../../grub2 BZ#( 2101818 ) Large repositories do not synchronize on limited or slow networks In environments with limited network or system speeds, attempts to synchronize large repositories fail with the following error: Katello::Errors::Pulp3Error: Response payload is not completed . BZ#( 2093028 ) Creation of the virt-who configuration on the nutanix environment occasionally fails During the creation of the virt-who configuration on the nutanix environment, the following error message occurs occasionally: Invalid option for hypervisor [ahv] for ui/CLI/API . As a workaround, restart both the Satellite Servers and the virt-who service. BZ#( 2095187 ) Non-enabled repository types appear occasionally in API documentation and examples Because the apipie cache is generated statically rather than with a running instance of Red Hat Satellite 6.11, non-enabled repository types, such as deb and python, appear in the API documentation and examples occasionally. BZ#( 2043126 ) Updates of foreman-protector packages on RHEL 8 fail when run with yum command Attempts to update the foreman-maintain packages using the yum command fail on RHEL 8. As a workaround, use the dnf command instead. BZ#( 2091900 ) Shortname usage might cause breakages Shortname usage on a Satellite Server or Capsule Server might cause breakages in certain workflows. 1.5. Deprecated functionality The items in this section are either no longer supported or will no longer be supported in a future release : Foreman Hooks Foreman Hooks functionality has been deprecated and will be removed in a future release. The functionality will be replaced by the new Foreman Webhooks feature that will be documented with its release. Provisioning on Red Hat Virtualization The integration of Red Hat Virtualization (RHV) with Satellite is deprecated and will be removed in a future release. All the existing compute resources of RHV type will be removed and the hosts associated with RHV will be disconnected. Bootstrap.py The bootstrap.py script used to register a host to Satellite or Capsule Server has been replaced with the curl command created with the global registration template. Entitlements Entitlement-based Subscription Management is deprecated and will be removed in a future release. It is recommended to use Simple Content Access , which simplifies the entitlement experience for administrators in regards to subscriptions as a substitute. Katello-agent Katello-agent is deprecated and will be removed in a future release. Transition your workloads to use the Remote Execution feature. Katello-ca-consumer package The katello-ca-consumer package is deprecated and will be removed in a future release. Use the global registration template for registering a host to Red Hat Satellite. :unattended: Setting Previously, Red Hat Satellite has supported the :unattended setting in the settings.yaml file, but this has been deprecated and a future release will remove this setting. Red Hat Satellite will default to the true setting in the future. 1.6. Removed functionality Puppet run API Puppet run API has been removed in Red Hat Satellite 6.11. Red Hat Satellite content ISOs Red Hat Satellite content ISOs are not updated on the Customer Portal with this release. Use a connected Red Hat Satellite instance to generate an export dump to be imported on a disconnected instance of Red Hat Satellite.
[ "hammer discovery provision --name discovered_host_name --hostgroup-id your_hostgroup_id --organization-id your_organization_id --location-id your_location_id --new-name new_host_name --build true" ]
https://docs.redhat.com/en/documentation/red_hat_satellite/6.11/html/release_notes/assembly_introducing-red-hat-satellite_sat6-release-notes
Chapter 7. Setting up to Develop Applications Using Python
Chapter 7. Setting up to Develop Applications Using Python The Python language version 2.7.5 is available as part of Red Hat Enterprise Linux. Newer versions of the Python interpreter and libraries (including a newer version of Python 2.7) are available as Red Hat Software Collections packages. Install the package with the desired version according to the table below. Python versions corresponding to Red Hat Software Collections packages Version Package Python 2.7 python27 Python 3.6 rh-python36 Python 3.8 rh-python38 The python27 software collection is an updated version of the Python 2 packages in RHEL 7. Install the Eclipse integrated development environment which supports development in the Python language. Eclipse is available as part of Red Hat Developer Tools. For the actual installation procedure, see Using Eclipse . Additional Resources Red Hat Software Collections Hello-World - Python Red Hat Software Collections
[ "yum install package" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/developer_guide/setting-up_setup-developing-python
Chapter 2. Installing and configuring the MTR plugin
Chapter 2. Installing and configuring the MTR plugin You can install the MTR plugin and configure it to use the MTR CLI for analysis execution. 2.1. Installing in a connected environment You need a connected environment to install the MTR plugin. The MTR plugin has been tested with the Eclipse IDE for Java Enterprise Developers 2023-03. Prerequisites The following are the prerequisites for the Migration Toolkit for Runtimes (MTR) installation: Java Development Kit (JDK) is installed. MTR supports the following JDKs: OpenJDK 11 OpenJDK 17 Oracle JDK 11 Oracle JDK 17 Eclipse TemurinTM JDK 11 Eclipse TemurinTM JDK 17 8 GB RAM macOS installation: the value of maxproc must be 2048 or greater. Eclipse IDE for Java Enterprise Developers 2023-03 JBoss Tools, installed from the Eclipse Marketplace Mylyn SDK and frameworks , installed with Eclipse Note Eclipse is pre-configured for Java 17, and the plugin operates directly with Java 17. You can also run the plugin with Java 11, which requires setting the JRE version to Java 11 when creating up a new Eclipse project or importing an existing one. See step 6 below. Procedure Launch Eclipse. From the menu bar, select Help Install New Software . to the Work with field, click Add . In the Name field, enter MTR . In the Location field, enter https://marketplace.eclipse.org/content/migration-toolkit-runtimes-mtr and click OK . Select the Java version to use. If using Java 11, in the JRE list, select JavaSE 11 . If using Java 17, leave the JRE selection unchanged. Select all the JBoss Tools - MTR check boxes and click . Review the installation details and click . Accept the terms of the license agreement and click Finish . Restart Eclipse. 2.2. Configuring the MTR plugin to use the MTR CLI for analysis execution You can configure the MTR plugin to use the MTR CLI for analysis execution. Prerequisites You have downloaded the MTR CLI from the Developers Website or Customer Portal and installed it locally. Procedure Click the Configure MTR icon to open the configuration settings. Populate the CLI field with the path to the parent directory of the CLI. Click Apply .
null
https://docs.redhat.com/en/documentation/migration_toolkit_for_runtimes/1.2/html/eclipse_plugin_guide/installing-plugin_eclipse-code-ready-studio-guide
Chapter 4. LVM Administration with CLI Commands
Chapter 4. LVM Administration with CLI Commands This chapter summarizes the individual administrative tasks you can perform with the LVM Command Line Interface (CLI) commands to create and maintain logical volumes. Note If you are creating or modifying an LVM volume for a clustered environment, you must ensure that you are running the clvmd daemon. For information, see see Section 3.1, "Creating LVM Volumes in a Cluster" . 4.1. Using CLI Commands There are several general features of all LVM CLI commands. When sizes are required in a command line argument, units can always be specified explicitly. If you do not specify a unit, then a default is assumed, usually KB or MB. LVM CLI commands do not accept fractions. When specifying units in a command line argument, LVM is case-insensitive; specifying M or m is equivalent, for example, and powers of 2 (multiples of 1024) are used. However, when specifying the --units argument in a command, lower-case indicates that units are in multiples of 1024 while upper-case indicates that units are in multiples of 1000. Where commands take volume group or logical volume names as arguments, the full path name is optional. A logical volume called lvol0 in a volume group called vg0 can be specified as vg0/lvol0 . Where a list of volume groups is required but is left empty, a list of all volume groups will be substituted. Where a list of logical volumes is required but a volume group is given, a list of all the logical volumes in that volume group will be substituted. For example, the lvdisplay vg0 command will display all the logical volumes in volume group vg0 . All LVM commands accept a -v argument, which can be entered multiple times to increase the output verbosity. For example, the following examples shows the default output of the lvcreate command. The following command shows the output of the lvcreate command with the -v argument. You could also have used the -vv , -vvv or the -vvvv argument to display increasingly more details about the command execution. The -vvvv argument provides the maximum amount of information at this time. The following example shows only the first few lines of output for the lvcreate command with the -vvvv argument specified. You can display help for any of the LVM CLI commands with the --help argument of the command. To display the man page for a command, execute the man command: The man lvm command provides general online information about LVM. All LVM objects are referenced internally by a UUID, which is assigned when you create the object. This can be useful in a situation where you remove a physical volume called /dev/sdf which is part of a volume group and, when you plug it back in, you find that it is now /dev/sdk . LVM will still find the physical volume because it identifies the physical volume by its UUID and not its device name. For information on specifying the UUID of a physical volume when creating a physical volume, see see Section 6.4, "Recovering Physical Volume Metadata" .
[ "lvcreate -L 50MB new_vg Rounding up size to full physical extent 52.00 MB Logical volume \"lvol0\" created", "lvcreate -v -L 50MB new_vg Finding volume group \"new_vg\" Rounding up size to full physical extent 52.00 MB Archiving volume group \"new_vg\" metadata (seqno 4). Creating logical volume lvol0 Creating volume group backup \"/etc/lvm/backup/new_vg\" (seqno 5). Found volume group \"new_vg\" Creating new_vg-lvol0 Loading new_vg-lvol0 table Resuming new_vg-lvol0 (253:2) Clearing start of logical volume \"lvol0\" Creating volume group backup \"/etc/lvm/backup/new_vg\" (seqno 5). Logical volume \"lvol0\" created", "lvcreate -vvvv -L 50MB new_vg #lvmcmdline.c:913 Processing: lvcreate -vvvv -L 50MB new_vg #lvmcmdline.c:916 O_DIRECT will be used #config/config.c:864 Setting global/locking_type to 1 #locking/locking.c:138 File-based locking selected. #config/config.c:841 Setting global/locking_dir to /var/lock/lvm #activate/activate.c:358 Getting target version for linear #ioctl/libdm-iface.c:1569 dm version OF [16384] #ioctl/libdm-iface.c:1569 dm versions OF [16384] #activate/activate.c:358 Getting target version for striped #ioctl/libdm-iface.c:1569 dm versions OF [16384] #config/config.c:864 Setting activation/mirror_region_size to 512", "commandname --help", "man commandname" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/4/html/cluster_logical_volume_manager/LVM_CLI
Chapter 63. Salesforce Update Sink
Chapter 63. Salesforce Update Sink Updates an object in Salesforce. The body received must contain a JSON key-value pair for each property to update and sObjectName and sObjectId must be provided as parameters. Example of key-value pair: { "Phone": "1234567890", "Name": "Antonia" } 63.1. Configuration Options The following table summarizes the configuration options available for the salesforce-update-sink Kamelet: Property Name Description Type Default Example clientId * Consumer Key The Salesforce application consumer key string clientSecret * Consumer Secret The Salesforce application consumer secret string password * Password The Salesforce user password string sObjectId * Object Id Id of the object. Only required if using key-value pair. string sObjectName * Object Name Type of the object. Only required if using key-value pair. string "Contact" userName * Username The Salesforce username string loginUrl Login URL The Salesforce instance login URL string "https://login.salesforce.com" Note Fields marked with an asterisk (*) are mandatory. 63.2. Dependencies At runtime, the salesforce-update-sink Kamelet relies upon the presence of the following dependencies: camel:salesforce camel:kamelet 63.3. Usage This section describes how you can use the salesforce-update-sink . 63.3.1. Knative Sink You can use the salesforce-update-sink Kamelet as a Knative sink by binding it to a Knative object. salesforce-update-sink-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: salesforce-update-sink-binding spec: source: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel sink: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: salesforce-update-sink properties: clientId: "The Consumer Key" clientSecret: "The Consumer Secret" password: "The Password" sObjectId: "The Object Id" sObjectName: "Contact" userName: "The Username" 63.3.1.1. Prerequisite Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 63.3.1.2. Procedure for using the cluster CLI Save the salesforce-update-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command: oc apply -f salesforce-update-sink-binding.yaml 63.3.1.3. Procedure for using the Kamel CLI Configure and run the sink by using the following command: kamel bind channel:mychannel salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username" This command creates the KameletBinding in the current namespace on the cluster. 63.3.2. Kafka Sink You can use the salesforce-update-sink Kamelet as a Kafka sink by binding it to a Kafka topic. salesforce-update-sink-binding.yaml apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: salesforce-update-sink-binding spec: source: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic sink: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: salesforce-update-sink properties: clientId: "The Consumer Key" clientSecret: "The Consumer Secret" password: "The Password" sObjectId: "The Object Id" sObjectName: "Contact" userName: "The Username" 63.3.2.1. Prerequisites Ensure that you've installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you're connected to. 63.3.2.2. Procedure for using the cluster CLI Save the salesforce-update-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration. Run the sink by using the following command: oc apply -f salesforce-update-sink-binding.yaml 63.3.2.3. Procedure for using the Kamel CLI Configure and run the sink by using the following command: kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic salesforce-update-sink -p "sink.clientId=The Consumer Key" -p "sink.clientSecret=The Consumer Secret" -p "sink.password=The Password" -p "sink.sObjectId=The Object Id" -p "sink.sObjectName=Contact" -p "sink.userName=The Username" This command creates the KameletBinding in the current namespace on the cluster. 63.4. Kamelet source file https://github.com/openshift-integration/kamelet-catalog/salesforce-update-sink.kamelet.yaml
[ "apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: salesforce-update-sink-binding spec: source: ref: kind: Channel apiVersion: messaging.knative.dev/v1 name: mychannel sink: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: salesforce-update-sink properties: clientId: \"The Consumer Key\" clientSecret: \"The Consumer Secret\" password: \"The Password\" sObjectId: \"The Object Id\" sObjectName: \"Contact\" userName: \"The Username\"", "apply -f salesforce-update-sink-binding.yaml", "kamel bind channel:mychannel salesforce-update-sink -p \"sink.clientId=The Consumer Key\" -p \"sink.clientSecret=The Consumer Secret\" -p \"sink.password=The Password\" -p \"sink.sObjectId=The Object Id\" -p \"sink.sObjectName=Contact\" -p \"sink.userName=The Username\"", "apiVersion: camel.apache.org/v1alpha1 kind: KameletBinding metadata: name: salesforce-update-sink-binding spec: source: ref: kind: KafkaTopic apiVersion: kafka.strimzi.io/v1beta1 name: my-topic sink: ref: kind: Kamelet apiVersion: camel.apache.org/v1alpha1 name: salesforce-update-sink properties: clientId: \"The Consumer Key\" clientSecret: \"The Consumer Secret\" password: \"The Password\" sObjectId: \"The Object Id\" sObjectName: \"Contact\" userName: \"The Username\"", "apply -f salesforce-update-sink-binding.yaml", "kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic salesforce-update-sink -p \"sink.clientId=The Consumer Key\" -p \"sink.clientSecret=The Consumer Secret\" -p \"sink.password=The Password\" -p \"sink.sObjectId=The Object Id\" -p \"sink.sObjectName=Contact\" -p \"sink.userName=The Username\"" ]
https://docs.redhat.com/en/documentation/red_hat_build_of_apache_camel_k/1.10.7/html/kamelets_reference/salesforce-sink-update
Chapter 16. Replacing a failed disk
Chapter 16. Replacing a failed disk If a disk in your Ceph Storage cluster fails, you can replace it. 16.1. Replacing a disk See Adding OSDs in the Red Hat Ceph Storage Installation Guide for information on replacing a failed disk.
null
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/17.0/html/deploying_red_hat_ceph_storage_and_red_hat_openstack_platform_together_with_director/assembly_replacing-a-failed-disk_deployingcontainerizedrhcs
Chapter 11. Using service accounts in applications
Chapter 11. Using service accounts in applications 11.1. Service accounts overview A service account is an OpenShift Container Platform account that allows a component to directly access the API. Service accounts are API objects that exist within each project. Service accounts provide a flexible way to control API access without sharing a regular user's credentials. When you use the OpenShift Container Platform CLI or web console, your API token authenticates you to the API. You can associate a component with a service account so that they can access the API without using a regular user's credentials. For example, service accounts can allow: Replication controllers to make API calls to create or delete pods. Applications inside containers to make API calls for discovery purposes. External applications to make API calls for monitoring or integration purposes. Each service account's user name is derived from its project and name: system:serviceaccount:<project>:<name> Every service account is also a member of two groups: Group Description system:serviceaccounts Includes all service accounts in the system. system:serviceaccounts:<project> Includes all service accounts in the specified project. Each service account automatically contains two secrets: An API token Credentials for the OpenShift Container Registry The generated API token and registry credentials do not expire, but you can revoke them by deleting the secret. When you delete the secret, a new one is automatically generated to take its place. 11.2. Default service accounts Your OpenShift Container Platform cluster contains default service accounts for cluster management and generates more service accounts for each project. 11.2.1. Default cluster service accounts Several infrastructure controllers run using service account credentials. The following service accounts are created in the OpenShift Container Platform infrastructure project ( openshift-infra ) at server start, and given the following roles cluster-wide: Service Account Description replication-controller Assigned the system:replication-controller role deployment-controller Assigned the system:deployment-controller role build-controller Assigned the system:build-controller role. Additionally, the build-controller service account is included in the privileged security context constraint to create privileged build pods. 11.2.2. Default project service accounts and roles Three service accounts are automatically created in each project: Service Account Usage builder Used by build pods. It is given the system:image-builder role, which allows pushing images to any imagestream in the project using the internal Docker registry. deployer Used by deployment pods and given the system:deployer role, which allows viewing and modifying replication controllers and pods in the project. default Used to run all other pods unless they specify a different service account. All service accounts in a project are given the system:image-puller role, which allows pulling images from any imagestream in the project using the internal container image registry. 11.2.3. About automatically generated service account token secrets When a service account is created, a service account token secret is automatically generated for it. This service account token secret, along with an automatically generated docker configuration secret, is used to authenticate to the internal OpenShift Container Platform registry. Do not rely on these automatically generated secrets for your own use; they might be removed in a future OpenShift Container Platform release. Note Prior to OpenShift Container Platform 4.11, a second service account token secret was generated when a service account was created. This service account token secret was used to access the Kubernetes API. Starting with OpenShift Container Platform 4.11, this second service account token secret is no longer created. This is because the LegacyServiceAccountTokenNoAutoGeneration upstream Kubernetes feature gate was enabled, which stops the automatic generation of secret-based service account tokens to access the Kubernetes API. After upgrading to 4.13, any existing service account token secrets are not deleted and continue to function. Workloads are automatically injected with a projected volume to obtain a bound service account token. If your workload needs an additional service account token, add an additional projected volume in your workload manifest. Bound service account tokens are more secure than service account token secrets for the following reasons: Bound service account tokens have a bounded lifetime. Bound service account tokens contain audiences. Bound service account tokens can be bound to pods or secrets and the bound tokens are invalidated when the bound object is removed. For more information, see Configuring bound service account tokens using volume projection . You can also manually create a service account token secret to obtain a token, if the security exposure of a non-expiring token in a readable API object is acceptable to you. For more information, see Creating a service account token secret . Additional resources For information about requesting bound service account tokens, see Configuring bound service account tokens using volume projection . For information about creating a service account token secret, see Creating a service account token secret . 11.3. Creating service accounts You can create a service account in a project and grant it permissions by binding it to a role. Procedure Optional: To view the service accounts in the current project: USD oc get sa Example output NAME SECRETS AGE builder 2 2d default 2 2d deployer 2 2d To create a new service account in the current project: USD oc create sa <service_account_name> 1 1 To create a service account in a different project, specify -n <project_name> . Example output serviceaccount "robot" created Tip You can alternatively apply the following YAML to create the service account: apiVersion: v1 kind: ServiceAccount metadata: name: <service_account_name> namespace: <current_project> Optional: View the secrets for the service account: USD oc describe sa robot Example output Name: robot Namespace: project1 Labels: <none> Annotations: <none> Image pull secrets: robot-dockercfg-qzbhb Mountable secrets: robot-dockercfg-qzbhb Tokens: robot-token-f4khf Events: <none>
[ "system:serviceaccount:<project>:<name>", "oc get sa", "NAME SECRETS AGE builder 2 2d default 2 2d deployer 2 2d", "oc create sa <service_account_name> 1", "serviceaccount \"robot\" created", "apiVersion: v1 kind: ServiceAccount metadata: name: <service_account_name> namespace: <current_project>", "oc describe sa robot", "Name: robot Namespace: project1 Labels: <none> Annotations: <none> Image pull secrets: robot-dockercfg-qzbhb Mountable secrets: robot-dockercfg-qzbhb Tokens: robot-token-f4khf Events: <none>" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.13/html/authentication_and_authorization/using-service-accounts
Appendix C. HA Resource Behavior
Appendix C. HA Resource Behavior This appendix describes common behavior of HA resources. It is meant to provide ancillary information that may be helpful in configuring HA services. You can configure the parameters with luci or by editing /etc/cluster/cluster.conf . For descriptions of HA resource parameters, see Appendix B, HA Resource Parameters . To understand resource agents in more detail you can view them in /usr/share/cluster of any cluster node. Note To fully comprehend the information in this appendix, you may require detailed understanding of resource agents and the cluster configuration file, /etc/cluster/cluster.conf . An HA service is a group of cluster resources configured into a coherent entity that provides specialized services to clients. An HA service is represented as a resource tree in the cluster configuration file, /etc/cluster/cluster.conf (in each cluster node). In the cluster configuration file, each resource tree is an XML representation that specifies each resource, its attributes, and its relationship among other resources in the resource tree (parent, child, and sibling relationships). Note Because an HA service consists of resources organized into a hierarchical tree, a service is sometimes referred to as a resource tree or resource group . Both phrases are synonymous with HA service . At the root of each resource tree is a special type of resource - a service resource . Other types of resources comprise the rest of a service, determining its characteristics. Configuring an HA service consists of creating a service resource, creating subordinate cluster resources, and organizing them into a coherent entity that conforms to hierarchical restrictions of the service. This appendix consists of the following sections: Section C.1, "Parent, Child, and Sibling Relationships Among Resources" Section C.2, "Sibling Start Ordering and Resource Child Ordering" Section C.3, "Inheritance, the <resources> Block, and Reusing Resources" Section C.4, "Failure Recovery and Independent Subtrees" Section C.5, "Debugging and Testing Services and Resource Ordering" Note The sections that follow present examples from the cluster configuration file, /etc/cluster/cluster.conf , for illustration purposes only. C.1. Parent, Child, and Sibling Relationships Among Resources A cluster service is an integrated entity that runs under the control of rgmanager . All resources in a service run on the same node. From the perspective of rgmanager , a cluster service is one entity that can be started, stopped, or relocated. Within a cluster service, however, the hierarchy of the resources determines the order in which each resource is started and stopped.The hierarchical levels consist of parent, child, and sibling. Example C.1, "Resource Hierarchy of Service foo" shows a sample resource tree of the service foo . In the example, the relationships among the resources are as follows: fs:myfs (<fs name="myfs" ...>) and ip:10.1.1.2 (<ip address="10.1.1.2 .../>) are siblings. fs:myfs (<fs name="myfs" ...>) is the parent of script:script_child (<script name="script_child"/>). script:script_child (<script name="script_child"/>) is the child of fs:myfs (<fs name="myfs" ...>). Example C.1. Resource Hierarchy of Service foo The following rules apply to parent/child relationships in a resource tree: Parents are started before children. Children must all stop cleanly before a parent may be stopped. For a resource to be considered in good health, all its children must be in good health. Note When configuring a dependency tree for a cluster service that includes a floating IP address resource, you must configure the IP resource as the first entry and not as the child of another resource.
[ "<service name=\"foo\" ...> <fs name=\"myfs\" ...> <script name=\"script_child\"/> </fs> <ip address=\"10.1.1.2\" .../> </service>" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/cluster_administration/ap-ha-resource-behavior-CA
4.4. Securing Network Access
4.4. Securing Network Access 4.4.1. Securing Services With TCP Wrappers and xinetd TCP Wrappers are capable of much more than denying access to services. This section illustrates how they can be used to send connection banners, warn of attacks from particular hosts, and enhance logging functionality. See the hosts_options (5) man page for information about the TCP Wrapper functionality and control language. See the xinetd.conf (5) man page for the available flags, which act as options you can apply to a service. 4.4.1.1. TCP Wrappers and Connection Banners Displaying a suitable banner when users connect to a service is a good way to let potential attackers know that the system administrator is being vigilant. You can also control what information about the system is presented to users. To implement a TCP Wrappers banner for a service, use the banner option. This example implements a banner for vsftpd . To begin, create a banner file. It can be anywhere on the system, but it must have same name as the daemon. For this example, the file is called /etc/banners/vsftpd and contains the following lines: 220-Hello, %c 220-All activity on ftp.example.com is logged. 220-Inappropriate use will result in your access privileges being removed. The %c token supplies a variety of client information, such as the user name and host name, or the user name and IP address to make the connection even more intimidating. For this banner to be displayed to incoming connections, add the following line to the /etc/hosts.allow file: vsftpd : ALL : banners /etc/banners/ 4.4.1.2. TCP Wrappers and Attack Warnings If a particular host or network has been detected attacking the server, TCP Wrappers can be used to warn the administrator of subsequent attacks from that host or network using the spawn directive. In this example, assume that a cracker from the 206.182.68.0/24 network has been detected attempting to attack the server. Place the following line in the /etc/hosts.deny file to deny any connection attempts from that network, and to log the attempts to a special file: ALL : 206.182.68.0 : spawn /bin/echo `date` %c %d >> /var/log/intruder_alert The %d token supplies the name of the service that the attacker was trying to access. To allow the connection and log it, place the spawn directive in the /etc/hosts.allow file. Note Because the spawn directive executes any shell command, it is a good idea to create a special script to notify the administrator or execute a chain of commands in the event that a particular client attempts to connect to the server. 4.4.1.3. TCP Wrappers and Enhanced Logging If certain types of connections are of more concern than others, the log level can be elevated for that service using the severity option. For this example, assume that anyone attempting to connect to port 23 (the Telnet port) on an FTP server is a cracker. To denote this, place an emerg flag in the log files instead of the default flag, info , and deny the connection. To do this, place the following line in /etc/hosts.deny : in.telnetd : ALL : severity emerg This uses the default authpriv logging facility, but elevates the priority from the default value of info to emerg , which posts log messages directly to the console. 4.4.2. Verifying Which Ports Are Listening It is important to close unused ports to avoid possible attacks. For unexpected ports in listening state, you should investigate for possible signs of intrusion. Using netstat for Open Ports Scan Enter the following command as root to determine which ports are listening for connections from the network: Use the -l option of the netstat command to display only listening server sockets: Using ss for Open Ports Scan Alternatively, use the ss utility to list open ports in the listening state. It can display more TCP and state information than netstat . The UNCONN state shows the ports in UDP listening mode. Make a scan for every IP address shown in the ss output (except for localhost 127.0.0.0 or ::1 range) from an external system. Use the -6 option for scanning an IPv6 address. Proceed then to make external checks using the nmap tool from another remote machine connected through the network to the first system. This can be used to verify rules in firewalld . The following is an example to determine which ports are listening for TCP connections: The TCP connect scan (-sT) is the default TCP scan type when the TCP SYN scan (-sS) is not an option. The -O option detects the operating system of the host. Using netstat and ss to Scan for Open SCTP Ports The netstat utility prints information about the Linux networking subsystem. To display protocol statistics for open Stream Control Transmission Protocol (SCTP) ports, enter the following command as root : The ss utility is also able to show SCTP open ports: See the ss (8) , netstat (8) , nmap (1) , and services (5) manual pages for more information. 4.4.3. Disabling Source Routing Source routing is an Internet Protocol mechanism that allows an IP packet to carry information, a list of addresses, that tells a router the path the packet must take. There is also an option to record the hops as the route is traversed. The list of hops taken, the "route record", provides the destination with a return path to the source. This allows the source (the sending host) to specify the route, loosely or strictly, ignoring the routing tables of some or all of the routers. It can allow a user to redirect network traffic for malicious purposes. Therefore, source-based routing should be disabled. The accept_source_route option causes network interfaces to accept packets with the Strict Source Routing ( SSR ) or Loose Source Routing ( LSR ) option set. The acceptance of source routed packets is controlled by sysctl settings. Issue the following command as root to drop packets with the SSR or LSR option set: Disabling the forwarding of packets should also be done in conjunction with the above when possible (disabling forwarding may interfere with virtualization). Issue the commands listed below as root: These commands disable forwarding of IPv4 and IPv6 packets on all interfaces: These commands disable forwarding of all multicast packets on all interfaces: Accepting ICMP redirects has few legitimate uses. Disable the acceptance and sending of ICMP redirected packets unless specifically required. These commands disable acceptance of all ICMP redirected packets on all interfaces: This command disables acceptance of secure ICMP redirected packets on all interfaces: This command disables acceptance of all IPv4 ICMP redirected packets on all interfaces: Important Sending of ICMP redirects remains active if at least one of the net.ipv4.conf.all.send_redirects or net.ipv4.conf. interface .send_redirects options is set to enabled. Ensure that you set the net.ipv4.conf. interface .send_redirects option to the 0 value for every interface . To automatically disable sending of ICMP requests whenever you add a new interface, enter the following command: There is only a directive to disable sending of IPv4 redirected packets. See RFC4294 for an explanation of " IPv6 Node Requirements " which resulted in this difference between IPv4 and IPv6. Note To make these settings persistent across reboots, modify the /etc/sysctl.conf file. For example, to disable acceptance of all IPv4 ICMP redirected packets on all interfaces, open the /etc/sysctl.conf file with an editor running as the root user and add a line as follows: net.ipv4.conf.all.send_redirects=0 See the sysctl man page, sysctl(8) , for more information. See RFC791 for an explanation of the Internet options related to source based routing and its variants. Warning Ethernet networks provide additional ways to redirect traffic, such as ARP or MAC address spoofing, unauthorized DHCP servers, and IPv6 router or neighbor advertisements. In addition, unicast traffic is occasionally broadcast, causing information leaks. These weaknesses can only be addressed by specific countermeasures implemented by the network operator. Host-based countermeasures are not fully effective. 4.4.3.1. Reverse Path Forwarding Reverse Path Forwarding is used to prevent packets that arrived through one interface from leaving through a different interface. When outgoing routes and incoming routes are different, it is sometimes referred to as asymmetric routing . Routers often route packets this way, but most hosts should not need to do this. Exceptions are such applications that involve sending traffic out over one link and receiving traffic over another link from a different service provider. For example, using leased lines in combination with xDSL or satellite links with 3G modems. If such a scenario is applicable to you, then turning off reverse path forwarding on the incoming interface is necessary. In short, unless you know that it is required, it is best enabled as it prevents users spoofing IP addresses from local subnets and reduces the opportunity for DDoS attacks. Note Red Hat Enterprise Linux 7 defaults to using Strict Reverse Path Forwarding following the Strict Reverse Path recommendation from RFC 3704, Ingress Filtering for Multihomed Networks .. Warning If forwarding is enabled, then Reverse Path Forwarding should only be disabled if there are other means for source-address validation (such as iptables rules for example). rp_filter Reverse Path Forwarding is enabled by means of the rp_filter directive. The sysctl utility can be used to make changes to the running system, and permanent changes can be made by adding lines to the /etc/sysctl.conf file. The rp_filter option is used to direct the kernel to select from one of three modes. To make a temporary global change, enter the following commands as root : where integer is one of the following: 0 - No source validation. 1 - Strict mode as defined in RFC 3704. 2 - Loose mode as defined in RFC 3704. The setting can be overridden per network interface using the net.ipv4.conf. interface .rp_filter command as follows: sysctl -w net.ipv4.conf. interface .rp_filter= integer Note To make these settings persistent across reboots, modify the /etc/sysctl.conf file. For example, to change the mode for all interfaces, open the /etc/sysctl.conf file with an editor running as the root user and add a line as follows: net.ipv4.conf.all.rp_filter=2 IPv6_rpfilter In case of the IPv6 protocol the firewalld daemon applies to Reverse Path Forwarding by default. The setting can be checked in the /etc/firewalld/firewalld.conf file. You can change the firewalld behavior by setting the IPv6_rpfilter option. If you need a custom configuration of Reverse Path Forwarding, you can perform it without the firewalld daemon by using the ip6tables command as follows: ip6tables -t raw -I PREROUTING -m rpfilter --invert -j DROP This rule should be inserted near the beginning of the raw/PREROUTING chain, so that it applies to all traffic, in particular before the stateful matching rules. For more information about the iptables and ip6tables services, see Section 5.13, "Setting and Controlling IP sets using iptables " . Enabling Packet Forwarding To enable packets arriving from outside of a system to be forwarded to another external host, IP forwarding must be enabled in the kernel. Log in as root and change the line which reads net.ipv4.ip_forward = 0 in the /etc/sysctl.conf file to the following: To load the changes from the /etc/sysctl.conf file, enter the following command: To check if IP forwarding is turned on, issue the following command as root : If the above command returns a 1 , then IP forwarding is enabled. If it returns a 0 , then you can turn it on manually using the following command: 4.4.3.2. Additional Resources The following are resources which explain more about Reverse Path Forwarding. Installed Documentation /usr/share/doc/kernel-doc- version /Documentation/networking/ip-sysctl.txt - This file contains a complete list of files and options available in the directory. Before accessing the kernel documentation for the first time, enter the following command as root : Online Documentation See RFC 3704 for an explanation of Ingress Filtering for Multihomed Networks.
[ "220-Hello, %c 220-All activity on ftp.example.com is logged. 220-Inappropriate use will result in your access privileges being removed.", "vsftpd : ALL : banners /etc/banners/", "ALL : 206.182.68.0 : spawn /bin/echo `date` %c %d >> /var/log/intruder_alert", "in.telnetd : ALL : severity emerg", "~]# netstat -pan -A inet,inet6 | grep -v ESTABLISHED Active Internet connections (servers and established) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name Active Internet connections (servers and established) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name tcp 0 0 0.0.0.0:111 0.0.0.0:* LISTEN 1/systemd tcp 0 0 192.168.124.1:53 0.0.0.0:* LISTEN 1829/dnsmasq tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN 1176/sshd tcp 0 0 127.0.0.1:631 0.0.0.0:* LISTEN 1177/cupsd tcp6 0 0 :::111 :::* LISTEN 1/systemd tcp6 0 0 ::1:25 :::* LISTEN 1664/master sctp 0.0.0.0:2500 LISTEN 20985/sctp_darn udp 0 0 192.168.124.1:53 0.0.0.0:* 1829/dnsmasq udp 0 0 0.0.0.0:67 0.0.0.0:* 977/dhclient", "~]# netstat -tlnw Active Internet connections (only servers) Proto Recv-Q Send-Q Local Address Foreign Address State tcp 0 0 0.0.0.0:111 0.0.0.0:* LISTEN tcp 0 0 192.168.124.1:53 0.0.0.0:* LISTEN tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN tcp 0 0 127.0.0.1:631 0.0.0.0:* LISTEN tcp 0 0 127.0.0.1:25 0.0.0.0:* LISTEN tcp6 0 0 :::111 :::* LISTEN tcp6 0 0 :::22 :::* LISTEN tcp6 0 0 ::1:631 :::* LISTEN tcp6 0 0 ::1:25 :::* LISTEN raw6 0 0 :::58 :::* 7", "~]# ss -tlw etid State Recv-Q Send-Q Local Address:Port Peer Address:Port udp UNCONN 0 0 :::ipv6-icmp :::* tcp LISTEN 0 128 *:sunrpc *:* tcp LISTEN 0 5 192.168.124.1:domain *:* tcp LISTEN 0 128 *:ssh *:* tcp LISTEN 0 128 127.0.0.1:ipp *:* tcp LISTEN 0 100 127.0.0.1:smtp *:* tcp LISTEN 0 128 :::sunrpc :::* tcp LISTEN 0 128 :::ssh :::* tcp LISTEN 0 128 ::1:ipp :::* tcp LISTEN 0 100 ::1:smtp :::*", "~]# ss -plno -A tcp,udp,sctp Netid State Recv-Q Send-Q Local Address:Port Peer Address:Port udp UNCONN 0 0 192.168.124.1:53 *:* users:((\"dnsmasq\",pid=1829,fd=5)) udp UNCONN 0 0 *%virbr0:67 *:* users:((\"dnsmasq\",pid=1829,fd=3)) udp UNCONN 0 0 *:68 *:* users:((\"dhclient\",pid=977,fd=6)) tcp LISTEN 0 5 192.168.124.1:53 *:* users:((\"dnsmasq\",pid=1829,fd=6)) tcp LISTEN 0 128 *:22 *:* users:((\"sshd\",pid=1176,fd=3)) tcp LISTEN 0 128 127.0.0.1:631 *:* users:((\"cupsd\",pid=1177,fd=12)) tcp LISTEN 0 100 127.0.0.1:25 *:* users:((\"master\",pid=1664,fd=13)) sctp LISTEN 0 5 *:2500 *:* users:((\"sctp_darn\",pid=20985,fd=3))", "~]# nmap -sT -O 192.168.122.65 Starting Nmap 6.40 ( http://nmap.org ) at 2017-03-27 09:30 CEST Nmap scan report for 192.168.122.65 Host is up (0.00032s latency). Not shown: 998 closed ports PORT STATE SERVICE 22/tcp open ssh 111/tcp open rpcbind Device type: general purpose Running: Linux 3.X OS CPE: cpe:/o:linux:linux_kernel:3 OS details: Linux 3.7 - 3.9 Network Distance: 0 hops OS detection performed. Please report any incorrect results at http://nmap.org/submit/ . Nmap done: 1 IP address (1 host up) scanned in 1.79 seconds", "~]# netstat -plnS Active Internet connections (only servers) Proto Recv-Q Send-Q Local Address Foreign Address State PID/Program name sctp 127.0.0.1:250 LISTEN 4125/sctp_darn sctp 0 0 127.0.0.1:260 127.0.0.1:250 CLOSE 4250/sctp_darn sctp 0 0 127.0.0.1:250 127.0.0.1:260 LISTEN 4125/sctp_darn", "~]# netstat -nl -A inet,inet6 | grep 2500 sctp 0.0.0.0:2500 LISTEN", "~]# ss -an | grep 2500 sctp LISTEN 0 5 *:2500 *:*", "~]# /sbin/sysctl -w net.ipv4.conf.all.accept_source_route=0", "~]# /sbin/sysctl -w net.ipv4.conf.all.forwarding=0", "~]# /sbin/sysctl -w net.ipv6.conf.all.forwarding=0", "~]# /sbin/sysctl -w net.ipv4.conf.all.mc_forwarding=0", "~]# /sbin/sysctl -w net.ipv6.conf.all.mc_forwarding=0", "~]# /sbin/sysctl -w net.ipv4.conf.all.accept_redirects=0", "~]# /sbin/sysctl -w net.ipv6.conf.all.accept_redirects=0", "~]# /sbin/sysctl -w net.ipv4.conf.all.secure_redirects=0", "~]# /sbin/sysctl -w net.ipv4.conf.all.send_redirects=0", "~]# /sbin/sysctl -w net.ipv4.conf.default.send_redirects=0", "sysctl -w net.ipv4.conf.default.rp_filter= integer sysctl -w net.ipv4.conf.all.rp_filter= integer", "net.ipv4.ip_forward = 1", "/sbin/sysctl -p", "/sbin/sysctl net.ipv4.ip_forward", "/sbin/sysctl -w net.ipv4.ip_forward=1", "~]# yum install kernel-doc" ]
https://docs.redhat.com/en/documentation/Red_Hat_Enterprise_Linux/7/html/security_guide/sec-securing_network_access
Managing hybrid and multicloud resources
Managing hybrid and multicloud resources Red Hat OpenShift Data Foundation 4.13 Instructions for how to manage storage resources across a hybrid cloud or multicloud environment using the Multicloud Object Gateway (NooBaa). Red Hat Storage Documentation Team Abstract This document explains how to manage storage resources across a hybrid cloud or multicloud environment.
null
https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.13/html/managing_hybrid_and_multicloud_resources/index
Chapter 8. Supported components
Chapter 8. Supported components For a list of component versions that are supported in this release of Red Hat JBoss Web Server, see the JBoss Web Server Component Details page.
null
https://docs.redhat.com/en/documentation/red_hat_jboss_web_server/6.0/html/red_hat_jboss_web_server_6.0_service_pack_4_release_notes/supported_components
Chapter 3. Red Hat build of OpenJDK 8.0.442 release notes
Chapter 3. Red Hat build of OpenJDK 8.0.442 release notes The latest Red Hat build of OpenJDK 8 release might include new features. Additionally, the latest release might enhance, deprecate, or remove features that originated from earlier Red Hat build of OpenJDK 8 releases. Note For all the other changes and security fixes, see OpenJDK 8u442 Released . Red Hat build of OpenJDK new features and enhancements Review the following release notes to understand new features and feature enhancements that Red Hat build of OpenJDK 8.0.442 provides: Option for jar command to avoid overwriting files when extracting an archive In earlier Red Hat build of OpenJDK releases, when the jar tool extracted files from an archive, the jar tool overwrote any existing files with the same name in the target directory. Red Hat build of OpenJDK 8.0.442 adds a new ‐k option that you can use to ensure that the jar tool does not overwrite existing files. For example: Note In Red Hat build of OpenJDK 8.0.442, the jar tool retains the old behavior by default. If you do not explicitly specify the ‐k option, the jar tool automatically overwrites any existing files with the same name. See JDK-8335912 (JDK Bug System) and JDK bug system reference ID: JDK-8337499.
[ "jar xkf myfile.jar" ]
https://docs.redhat.com/en/documentation/red_hat_build_of_openjdk/8/html/release_notes_for_red_hat_build_of_openjdk_8.0.442/openjdk-80442-release-notes_openjdk
10.6. Recursion Editor (XML)
10.6. Recursion Editor (XML) 10.6.1. What is Recursion? Some XML schema define data structures that contain self referencing elements or datatypes. When generating XML documents, such data structures can produce an endless repetition of nested tags. This self nesting pattern is known as recursion. When generating virtual documents from XML Schema, the Teiid Designer detects recursive data structures in the XML Schema model and halts the recursive nesting pattern after two cycles. These two cycles serve different purposes when mapping the document: The first cycle can be thought of as an entry condition for the recursion. The mapping class located at this node defines a normal mapping transformation like that of any other in the document model. The second cycle defines a mapping transformation that will be performed repeatedly until conditions are met that will halt the document instance being generated by the JBoss Data Virtualization Server. This fragment of the document model is called the recursive fragment. The mapping transformation for this fragment is no different from the first, except that you can access the first cycle's mapping class attributes, plus you have the opportunity to specify the conditions that will halt the recursion. You can recognize a mapping class located at the second, recursive document fragment by the looping arrow button in the top left hand corner of the diagram object as shown below. When you model a virtual document based on an XML Schema model containing recursion, you can choose whether to treat the nested fragments as recursive. Use recursion only when the data access pattern from your data source(s) is also recursive; in other words, when the same query transformation is to be executed over and over to generate and map the nested document's data content. By default, the Teiid Designer does not mark the recursive fragments in document models to execute recursively in the JBoss Data Virtualization Server. To take advantage of this behavior, you must open the Recursion Editor in the recursive mapping class , mark the transformation query as recursive, and specify the recursion limit properties. 10.6.2. Recursion Editor (XML) The Recursion Editor lets you enable and limit recursion. The Recursion Editor button only displays on mapping classes, which have recursive patterns. For example, if you have an element named Employee which contains a element named Supervisor which itself contains an Employee element nested within it, you might need to limit the number of times the elements are nested within the document. You can set the following conditions to limit the recursion: A fixed number of results to the query. An SQL based criteria limit condition. A combination of both. To open the Recursion Editor, click the Recursion Editor button on the displayed mapping class. Figure 10.30. Open Recursion Editor Button Figure 10.31. Recursion Editor 10.6.3. Edit Recursion Properties To edit recursion properties: Select the Enable Recursion checkbox if you want the JBoss Data Virtualization Server to perform the query you specify to generate the nested tags within the XML document. Click the arrows beside the Count Limit box to limit the number of times to recursively perform the query. If you do not set a Limit Condition in the text area, the recursion finishes when the query reaches this limit. You can only set this limit to a maximum supported by your JBoss Data Virtualization Server . For more information about this limit, contact your system administrator. Click the Action When Count Limit Exceeded drop-down menu to instruct the JBoss Data Virtualization Server what to do if it encounters more results for the query than the count limit before it reaches the limit condition. Click the Edit button to launch the SQL to build a limiting condition for this recursion. Note The JBoss Data Virtualization Server will evaluate this condition each time it recursively performs this query. If this criteria clause evaluates false, the JBoss Data Virtualization Server performs the query recursively again unless it has reached the Count Limit. If the criteria evaluates true, the JBoss Data Virtualization Server performs the mapping for the current level and ends its recursive loop. When you have created the criteria, it displays in the Limit Condition box. When the JBoss Data Virtualization Server dynamically populates your XML documents at runtime, it will use the recursion specifications you entered here.
null
https://docs.redhat.com/en/documentation/red_hat_jboss_data_virtualization/6.4/html/user_guide_volume_1_teiid_designer/sect-recursion_editor_xml
Chapter 1. Load Balancing Solution Architecture
Chapter 1. Load Balancing Solution Architecture You can configure Satellite Server to use a load balancer to distribute client requests and network load across multiple Capsule Servers. This results in an overall performance improvement on Capsule Servers. This guide outlines how to prepare Satellite Server and Capsule Server for load balancing, and provides guidelines on how to configure a load balancer and register clients in a load-balanced setup. A load-balanced setup consists of the following components: Satellite Server Two or more Capsule Servers A load balancer Multiple clients Figure 1.1. Satellite Load Balancing Solution Architecture In a load-balanced setup, nearly all Capsule functionality continues to work as expected when one Capsule Server is down, for planned or unplanned maintenance. Load balancer works with the following services and features: Registration using subscription-manager Content Management with yum repositories Optional: Puppet Note In the load-balanced setup, a load balancer distributes load only for the services and features mentioned above. If other services, such as provisioning or virt-who, are running on the individual Capsules, you must access them directly through Capsules and not through the load balancer. Managing Puppet Limitations Puppet Certificate Authority (CA) management does not support certificate signing in a load-balanced setup. Puppet CA stores certificate information, such as the serial number counter and CRL, on the file system. Multiple writer processes that attempt to use the same data can corrupt it. To manage this Puppet limitation, complete the following steps: Configure Puppet certificate signing on one Capsule Server, typically the first system where you configure Capsule Server for load balancing. Configure the clients to send CA requests to port 8141 on a load balancer. Configure a load balancer to redirect CA requests from port 8141 to port 8140 on the system where you configure Capsule Server to sign Puppet certificates.
null
https://docs.redhat.com/en/documentation/red_hat_satellite/6.11/html/configuring_capsules_with_a_load_balancer/load-balancing-solution-architecture
Making open source more inclusive
Making open source more inclusive Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright's message .
null
https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.3/html/deploying_the_red_hat_ansible_automation_platform_operator_on_openshift_container_platform/making-open-source-more-inclusive
Chapter 2. Configuring the Fujitsu ETERNUS device
Chapter 2. Configuring the Fujitsu ETERNUS device Configure storage pools and ports on the device before you define the Fujitsu ETERNUS device as a Block Storage back end. Consult your device documentation for details on each step: Procedure Configure a LAN connection between the Controller nodes that host the Block Storage service and the MNT ports of the ETERNUS device. Configure a SAN connection between the Compute nodes and CA ports of the ETERNUS device. Log in to the ETERNUS device using an account with the Admin role. Enable the SMI-S of ETERNUS DX. Set the SSH key Add a user account with software role. Register an Advanced Copy Feature license and configure the copy table size. Create a storage pool for volumes. You use this pool later in the EternusPool setting in Section 3.1, "Creating driver definitions for each Fujitsu ETERNUS back end" . Optional: Create a separate storage pool for volume snapshots. This pool represents the EternusSnapPool setting in Section 3.1, "Creating driver definitions for each Fujitsu ETERNUS back end" . Optional: Create a Snap Data Pool Volume (SDPV) to enable Snap Data Pool (SDP) for the create a snapshot function. Tip Skip this step if you use a Thin Provision Pool for EternusSnapPool . Configure storage ports to be used by the Block Storage service. Set the storage ports ports to CA mode. To enable host-affinity for the storage ports, enter the following command from the ETERNUS CLI for each port: Replace <PROTO> with the storage protocol, such as fc or iscsi . Replace <CM#> and <CA#> with the name of the controller enclosure where the port is located. Replace <PORT> with the port number. Use the following commands to generate the SSH key on the undercloud, and upload the eternus.ietf file to the ETERNUS device. Note Save the eternus file for later use. For security reasons, do not copy or move it from the undercloud or overcloud.
[ "set <PROTO>-parameters -host-affinity enable -port <CM#> <CA#> <PORT>", "ssh-keygen -t rsa -N \"\" -f ./eternus ssh-keygen -e -f ./eternus.pub > ./eternus.ietf" ]
https://docs.redhat.com/en/documentation/red_hat_openstack_platform/16.0/html/fujitsu_eternus_back_end_guide/devicesetup
Chapter 2. Considerations for implementing the Load-balancing service
Chapter 2. Considerations for implementing the Load-balancing service You must make several decisions when you plan to deploy the Red Hat OpenStack Services on OpenShift (RHOSO) Load-balancing service (octavia) such as choosing which provider to use or whether to implement a highly available environment: Section 2.1, "Load-balancing service provider drivers" Section 2.2, "Load-balancing service (octavia) feature support matrix" Section 2.3, "Load-balancing service software requirements" Section 2.4, "Basics of active-standby topology for Load-balancing service instances" 2.1. Load-balancing service provider drivers The Red Hat OpenStack Services on OpenShift (RHOSO) Load-balancing service (octavia) supports enabling multiple provider drivers by using the Octavia v2 API. You can choose to use one provider driver, or multiple provider drivers simultaneously. RHOSO provides two load-balancing providers, amphora and Open Virtual Network (OVN). Important The load-balancing provider for OVN is available in this release as a Technology Preview , and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details . Amphora, the default, is a highly available load balancer with a feature set that scales with your compute environment. Because of this, amphora is suited for large-scale deployments. The OVN load-balancing provider is a lightweight load balancer with a basic feature set. OVN is typical for east-west, layer 4 network traffic. OVN provisions quickly and consumes fewer resources than a full-featured load-balancing provider such as amphora. Important The information in this section applies only to the amphora load-balancing provider, unless indicated otherwise. Additional resources Section 2.2, "Load-balancing service (octavia) feature support matrix" 2.2. Load-balancing service (octavia) feature support matrix The Red Hat OpenStack Services on OpenShift (RHOSO) Load-balancing service (octavia) provides two load-balancing providers, amphora and Open Virtual Network (OVN). Amphora is a full-featured load-balancing provider that requires a separate haproxy VM and an extra latency hop. OVN runs on every node and does not require a separate VM nor an extra hop. However, OVN has far fewer load-balancing features than amphora. Important The load-balancing provider driver for OVN is available in this release as a Technology Preview , and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details . The following table lists features in the Load-balancing service that 18.0 supports and in which maintenance release support for the feature began. Note If the feature is not listed, then RHOSO 18.0 does not support the feature. Table 2.1. Load-balancing service (octavia) feature support matrix Feature Support level in RHOSO 18.0 Amphora Provider OVN Provider ML2/OVN L3 HA Full support Technology preview ML2/OVN DVR Full support Technology preview DPDK No support No support SR-IOV No support No support Health monitors Full support No support Amphora active-standby Full support No support Terminated HTTPS load balancers (with barbican) Full support No support UDP Full support Technology preview Backup members Technology Preview only No support TLS client authentication Technology Preview only No support TLS back end encryption Technology Preview only No support Octavia flavors Full support No support Object tags Full support Technology preview Listener API timeouts Full support No support Log offloading Future release No support VIP access control list Full support No support Availability zones Full support No support Volume-based amphora No support No support Additional resources Section 2.1, "Load-balancing service provider drivers" 2.3. Load-balancing service software requirements The Red Hat OpenStack Services on OpenShift (RHOSO) Load-balancing service (octavia) requires that you configure the following core OpenStack components: Compute (nova) OpenStack Networking (neutron) Image (glance) Identity (keystone) MariaDB 2.4. Basics of active-standby topology for Load-balancing service instances When you deploy the Red Hat OpenStack Services on OpenShift (RHOSO) Load-balancing service (octavia), you can decide whether, by default, load balancers are highly available when users create them. If you want to give users a choice, then after RHOSO deployment, create a Load-balancing service flavor for creating highly available load balancers and a flavor for creating standalone load balancers. By default, the amphora provider driver is configured for a single Load-balancing service (amphora) instance topology with limited support for high availability (HA). However, you can make Load-balancing service instances highly available when you implement an active-standby topology. In this topology, the Load-balancing service boots an active and standby amphora instance for each load balancer, and maintains session persistence between each. If the active instance becomes unhealthy, the instance automatically fails over to the standby instance, making it active. The Load-balancing service health manager automatically rebuilds an instance that fails.
null
https://docs.redhat.com/en/documentation/red_hat_openstack_services_on_openshift/18.0/html/configuring_load_balancing_as_a_service/plan-lb-service_rhoso-lbaas
Chapter 110. AclRule schema reference
Chapter 110. AclRule schema reference Used in: KafkaUserAuthorizationSimple Full list of AclRule schema properties 110.1. AclRule schema properties Property Property type Description host string The host from which the action described in the ACL rule is allowed or denied. operation string (one of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs]) The operation property has been deprecated, and should now be configured using spec.authorization.acls[*].operations . Operation which will be allowed or denied. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All. operations string (one or more of [Read, Write, Delete, Alter, Describe, All, IdempotentWrite, ClusterAction, Create, AlterConfigs, DescribeConfigs]) array List of operations which will be allowed or denied. Supported operations are: Read, Write, Create, Delete, Alter, Describe, ClusterAction, AlterConfigs, DescribeConfigs, IdempotentWrite and All. resource AclRuleTopicResource , AclRuleGroupResource , AclRuleClusterResource , AclRuleTransactionalIdResource Indicates the resource for which given ACL rule applies. type string (one of [allow, deny]) The type of the rule. Currently the only supported type is allow . ACL rules with type allow are used to allow user to execute the specified operations. Default value is allow .
null
https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.7/html/streams_for_apache_kafka_api_reference/type-aclrule-reference
7.124. libtevent
7.124. libtevent 7.124.1. RHBA-2013:0354 - libtevent bug fix and enhancement update Updated libtevent packages that fix several bugs and add various enhancements are now available for Red Hat Enterprise Linux 6. The libtevent packages provide Tevent, an event system based on the talloc memory management library. Tevent supports many event types, including timers, signals, and the classic file descriptor events. Tevent also provides helpers to deal with asynchronous code represented by the tevent_req (Tevent Request) functions. Note The libtevent packages have been upgraded to upstream version 0.9.17, which provides a number of bug fixes and enhancements over the version. These updated libtevent packages are compliant with requirements of Samba 4. (BZ# 766336 ) All users of libtevent are advised to upgrade to these updated packages, which fix these bugs and add these enhancements.
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/6.4_technical_notes/libtevent
Chapter 2. BuildConfig [build.openshift.io/v1]
Chapter 2. BuildConfig [build.openshift.io/v1] Description Build configurations define a build process for new container images. There are three types of builds possible - a container image build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run // arbitrary container images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the container image registry specified in the "output" section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be // created. Each build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have "output" set can be used to test code or run a verification build. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object Required spec 2.1. Specification Property Type Description apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object BuildConfigSpec describes when and how builds are created status object BuildConfigStatus contains current state of the build config object. 2.1.1. .spec Description BuildConfigSpec describes when and how builds are created Type object Required strategy Property Type Description completionDeadlineSeconds integer completionDeadlineSeconds is an optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer failedBuildsHistoryLimit integer failedBuildsHistoryLimit is the number of old failed builds to retain. When a BuildConfig is created, the 5 most recent failed builds are retained unless this value is set. If removed after the BuildConfig has been created, all failed builds are retained. mountTrustedCA boolean mountTrustedCA bind mounts the cluster's trusted certificate authorities, as defined in the cluster's proxy configuration, into the build. This lets processes within a build trust components signed by custom PKI certificate authorities, such as private artifact repositories and HTTPS proxies. When this field is set to true, the contents of /etc/pki/ca-trust within the build are managed by the build container, and any changes to this directory or its subdirectories (for example - within a Dockerfile RUN instruction) are not persisted in the build's output image. nodeSelector object (string) nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored. output object BuildOutput is input to a build strategy and describes the container image that the strategy should produce. postCommit object A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory (USDPWD) set to the image's WORKDIR. The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container. There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute rake test --verbose . 1. Shell script: "postCommit": { "script": "rake test --verbose", } The above is a convenient form which is equivalent to: "postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] } 2. A command as the image entrypoint: "postCommit": { "commit": ["rake", "test", "--verbose"] } Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint . 3. Pass arguments to the default entrypoint: "postCommit": { "args": ["rake", "test", "--verbose"] } This form is only useful if the image entrypoint can handle arguments. 4. Shell script with arguments: "postCommit": { "script": "rake test USD1", "args": ["--verbose"] } This form is useful if you need to pass arguments that would otherwise be hard to quote properly in the shell script. In the script, USD0 will be "/bin/sh" and USD1, USD2, etc, are the positional arguments from Args. 5. Command with arguments: "postCommit": { "command": ["rake", "test"], "args": ["--verbose"] } This form is equivalent to appending the arguments to the Command slice. It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed. resources ResourceRequirements resources computes resource requirements to execute the build. revision object SourceRevision is the revision or commit information from the source for the build runPolicy string RunPolicy describes how the new build created from this build configuration will be scheduled for execution. This is optional, if not specified we default to "Serial". serviceAccount string serviceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount source object BuildSource is the SCM used for the build. strategy object BuildStrategy contains the details of how to perform a build. successfulBuildsHistoryLimit integer successfulBuildsHistoryLimit is the number of old successful builds to retain. When a BuildConfig is created, the 5 most recent successful builds are retained unless this value is set. If removed after the BuildConfig has been created, all successful builds are retained. triggers array triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation. triggers[] object BuildTriggerPolicy describes a policy for a single trigger that results in a new Build. 2.1.2. .spec.output Description BuildOutput is input to a build strategy and describes the container image that the strategy should produce. Type object Property Type Description imageLabels array imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used. imageLabels[] object ImageLabel represents a label applied to the resulting image. pushSecret LocalObjectReference PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). to ObjectReference to defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a container image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified. 2.1.3. .spec.output.imageLabels Description imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used. Type array 2.1.4. .spec.output.imageLabels[] Description ImageLabel represents a label applied to the resulting image. Type object Required name Property Type Description name string name defines the name of the label. It must have non-zero length. value string value defines the literal value of the label. 2.1.5. .spec.postCommit Description A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory (USDPWD) set to the image's WORKDIR. The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container. There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute rake test --verbose . Shell script: A command as the image entrypoint: Pass arguments to the default entrypoint: Shell script with arguments: Command with arguments: It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed. Type object Property Type Description args array (string) args is a list of arguments that are provided to either Command, Script or the container image's default entrypoint. The arguments are placed immediately after the command to be run. command array (string) command is the command to run. It may not be specified with Script. This might be needed if the image doesn't have /bin/sh , or if you do not want to use a shell. In all other cases, using Script might be more convenient. script string script is a shell script to be run with /bin/sh -ic . It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with rake test . If you need control over the image entrypoint, or if the image does not have /bin/sh , use Command and/or Args. The -i flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make ruby , bundle and other binaries available in the PATH. 2.1.6. .spec.revision Description SourceRevision is the revision or commit information from the source for the build Type object Required type Property Type Description git object GitSourceRevision is the commit information from a git source for a build type string type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' 2.1.7. .spec.revision.git Description GitSourceRevision is the commit information from a git source for a build Type object Property Type Description author object SourceControlUser defines the identity of a user of source control commit string commit is the commit hash identifying a specific commit committer object SourceControlUser defines the identity of a user of source control message string message is the description of a specific commit 2.1.8. .spec.revision.git.author Description SourceControlUser defines the identity of a user of source control Type object Property Type Description email string email of the source control user name string name of the source control user 2.1.9. .spec.revision.git.committer Description SourceControlUser defines the identity of a user of source control Type object Property Type Description email string email of the source control user name string name of the source control user 2.1.10. .spec.source Description BuildSource is the SCM used for the build. Type object Property Type Description binary object BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source. configMaps array configMaps represents a list of configMaps and their destinations that will be used for the build. configMaps[] object ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time. The content of the configmap referenced here will be copied into the destination directory instead of mounting. contextDir string contextDir specifies the sub-directory where the source code for the application exists. This allows to have buildable sources in directory other than root of repository. dockerfile string dockerfile is the raw contents of a Dockerfile which should be built. When this option is specified, the FROM may be modified based on your strategy base image and additional ENV stanzas from your strategy environment will be added after the FROM, but before the rest of your Dockerfile stanzas. The Dockerfile source type may be used with other options like git - in those cases the Git repo will have any innate Dockerfile replaced in the context dir. git object GitBuildSource defines the parameters of a Git SCM images array images describes a set of images to be used to provide source for the build images[] object ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. Image sources can either be used to extract content from an image and place it into the build context along with the repository source, or used directly during a multi-stage container image build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields). secrets array secrets represents a list of secrets and their destinations that will be used only for the build. secrets[] object SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. sourceSecret LocalObjectReference sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data's key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. type string type of build input to accept 2.1.11. .spec.source.binary Description BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source. Type object Property Type Description asFile string asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as /webapp.war for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'. 2.1.12. .spec.source.configMaps Description configMaps represents a list of configMaps and their destinations that will be used for the build. Type array 2.1.13. .spec.source.configMaps[] Description ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time. The content of the configmap referenced here will be copied into the destination directory instead of mounting. Type object Required configMap Property Type Description configMap LocalObjectReference configMap is a reference to an existing configmap that you want to use in your build. destinationDir string destinationDir is the directory where the files from the configmap should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. 2.1.14. .spec.source.git Description GitBuildSource defines the parameters of a Git SCM Type object Required uri Property Type Description httpProxy string httpProxy is a proxy used to reach the git repository over http httpsProxy string httpsProxy is a proxy used to reach the git repository over https noProxy string noProxy is the list of domains for which the proxy should not be used ref string ref is the branch/tag/ref to build. uri string uri points to the source that will be built. The structure of the source will depend on the type of build to run 2.1.15. .spec.source.images Description images describes a set of images to be used to provide source for the build Type array 2.1.16. .spec.source.images[] Description ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. Image sources can either be used to extract content from an image and place it into the build context along with the repository source, or used directly during a multi-stage container image build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields). Type object Required from Property Type Description as array (string) A list of image names that this source will be used in place of during a multi-stage container image build. For instance, a Dockerfile that uses "COPY --from=nginx:latest" will first check for an image source that has "nginx:latest" in this field before attempting to pull directly. If the Dockerfile does not reference an image source it is ignored. This field and paths may both be set, in which case the contents will be used twice. from ObjectReference from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from. paths array paths is a list of source and destination paths to copy from the image. This content will be copied into the build context prior to starting the build. If no paths are set, the build context will not be altered. paths[] object ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. pullSecret LocalObjectReference pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. 2.1.17. .spec.source.images[].paths Description paths is a list of source and destination paths to copy from the image. This content will be copied into the build context prior to starting the build. If no paths are set, the build context will not be altered. Type array 2.1.18. .spec.source.images[].paths[] Description ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. Type object Required sourcePath destinationDir Property Type Description destinationDir string destinationDir is the relative directory within the build directory where files copied from the image are placed. sourcePath string sourcePath is the absolute path of the file or directory inside the image to copy to the build directory. If the source path ends in /. then the content of the directory will be copied, but the directory itself will not be created at the destination. 2.1.19. .spec.source.secrets Description secrets represents a list of secrets and their destinations that will be used only for the build. Type array 2.1.20. .spec.source.secrets[] Description SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. Type object Required secret Property Type Description destinationDir string destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. secret LocalObjectReference secret is a reference to an existing secret that you want to use in your build. 2.1.21. .spec.strategy Description BuildStrategy contains the details of how to perform a build. Type object Property Type Description customStrategy object CustomBuildStrategy defines input parameters specific to Custom build. dockerStrategy object DockerBuildStrategy defines input parameters specific to container image build. jenkinsPipelineStrategy object JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines sourceStrategy object SourceBuildStrategy defines input parameters specific to an Source build. type string type is the kind of build strategy. 2.1.22. .spec.strategy.customStrategy Description CustomBuildStrategy defines input parameters specific to Custom build. Type object Required from Property Type Description buildAPIVersion string buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder env array (EnvVar) env contains additional environment variables you want to pass into a builder container. exposeDockerSocket boolean exposeDockerSocket will allow running Docker commands (and build container images) from inside the container. forcePull boolean forcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally from ObjectReference from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled pullSecret LocalObjectReference pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries secrets array secrets is a list of additional secrets that will be included in the build pod secrets[] object SecretSpec specifies a secret to be included in a build pod and its corresponding mount point 2.1.23. .spec.strategy.customStrategy.secrets Description secrets is a list of additional secrets that will be included in the build pod Type array 2.1.24. .spec.strategy.customStrategy.secrets[] Description SecretSpec specifies a secret to be included in a build pod and its corresponding mount point Type object Required secretSource mountPath Property Type Description mountPath string mountPath is the path at which to mount the secret secretSource LocalObjectReference secretSource is a reference to the secret 2.1.25. .spec.strategy.dockerStrategy Description DockerBuildStrategy defines input parameters specific to container image build. Type object Property Type Description buildArgs array (EnvVar) buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details. NOTE: Only the 'name' and 'value' fields are supported. Any settings on the 'valueFrom' field are ignored. dockerfilePath string dockerfilePath is the path of the Dockerfile that will be used to build the container image, relative to the root of the context (contextDir). Defaults to Dockerfile if unset. env array (EnvVar) env contains additional environment variables you want to pass into a builder container. forcePull boolean forcePull describes if the builder should pull the images from registry prior to building. from ObjectReference from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file. imageOptimizationPolicy string imageOptimizationPolicy describes what optimizations the system can use when building images to reduce the final size or time spent building the image. The default policy is 'None' which means the final build image will be equivalent to an image created by the container image build API. The experimental policy 'SkipLayers' will avoid commiting new layers in between each image step, and will fail if the Dockerfile cannot provide compatibility with the 'None' policy. An additional experimental policy 'SkipLayersAndWarn' is the same as 'SkipLayers' but simply warns if compatibility cannot be preserved. noCache boolean noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag pullSecret LocalObjectReference pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries volumes array volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes volumes[] object BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. 2.1.26. .spec.strategy.dockerStrategy.volumes Description volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes Type array 2.1.27. .spec.strategy.dockerStrategy.volumes[] Description BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. Type object Required name source mounts Property Type Description mounts array mounts represents the location of the volume in the image build container mounts[] object BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment. name string name is a unique identifier for this BuildVolume. It must conform to the Kubernetes DNS label standard and be unique within the pod. Names that collide with those added by the build controller will result in a failed build with an error message detailing which name caused the error. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names source object BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. 2.1.28. .spec.strategy.dockerStrategy.volumes[].mounts Description mounts represents the location of the volume in the image build container Type array 2.1.29. .spec.strategy.dockerStrategy.volumes[].mounts[] Description BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment. Type object Required destinationPath Property Type Description destinationPath string destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. 2.1.30. .spec.strategy.dockerStrategy.volumes[].source Description BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. Type object Required type Property Type Description configMap ConfigMapVolumeSource configMap represents a ConfigMap that should populate this volume csi CSIVolumeSource csi represents ephemeral storage provided by external CSI drivers which support this capability secret SecretVolumeSource secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret type string type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap 2.1.31. .spec.strategy.jenkinsPipelineStrategy Description JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines Type object Property Type Description env array (EnvVar) env contains additional environment variables you want to pass into a build pipeline. jenkinsfile string Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. jenkinsfilePath string JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir. 2.1.32. .spec.strategy.sourceStrategy Description SourceBuildStrategy defines input parameters specific to an Source build. Type object Required from Property Type Description env array (EnvVar) env contains additional environment variables you want to pass into a builder container. forcePull boolean forcePull describes if the builder should pull the images from registry prior to building. from ObjectReference from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled incremental boolean incremental flag forces the Source build to do incremental builds if true. pullSecret LocalObjectReference pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries scripts string scripts is the location of Source scripts volumes array volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes volumes[] object BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. 2.1.33. .spec.strategy.sourceStrategy.volumes Description volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes Type array 2.1.34. .spec.strategy.sourceStrategy.volumes[] Description BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment. Only a subset of Kubernetes Volume sources are supported. Type object Required name source mounts Property Type Description mounts array mounts represents the location of the volume in the image build container mounts[] object BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment. name string name is a unique identifier for this BuildVolume. It must conform to the Kubernetes DNS label standard and be unique within the pod. Names that collide with those added by the build controller will result in a failed build with an error message detailing which name caused the error. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names source object BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. 2.1.35. .spec.strategy.sourceStrategy.volumes[].mounts Description mounts represents the location of the volume in the image build container Type array 2.1.36. .spec.strategy.sourceStrategy.volumes[].mounts[] Description BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment. Type object Required destinationPath Property Type Description destinationPath string destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. 2.1.37. .spec.strategy.sourceStrategy.volumes[].source Description BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. Type object Required type Property Type Description configMap ConfigMapVolumeSource configMap represents a ConfigMap that should populate this volume csi CSIVolumeSource csi represents ephemeral storage provided by external CSI drivers which support this capability secret SecretVolumeSource secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret type string type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap 2.1.38. .spec.triggers Description triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation. Type array 2.1.39. .spec.triggers[] Description BuildTriggerPolicy describes a policy for a single trigger that results in a new Build. Type object Required type Property Type Description bitbucket object WebHookTrigger is a trigger that gets invoked using a webhook type of post generic object WebHookTrigger is a trigger that gets invoked using a webhook type of post github object WebHookTrigger is a trigger that gets invoked using a webhook type of post gitlab object WebHookTrigger is a trigger that gets invoked using a webhook type of post imageChange object ImageChangeTrigger allows builds to be triggered when an ImageStream changes type string type is the type of build trigger. Valid values: - GitHub GitHubWebHookBuildTriggerType represents a trigger that launches builds on GitHub webhook invocations - Generic GenericWebHookBuildTriggerType represents a trigger that launches builds on generic webhook invocations - GitLab GitLabWebHookBuildTriggerType represents a trigger that launches builds on GitLab webhook invocations - Bitbucket BitbucketWebHookBuildTriggerType represents a trigger that launches builds on Bitbucket webhook invocations - ImageChange ImageChangeBuildTriggerType represents a trigger that launches builds on availability of a new version of an image - ConfigChange ConfigChangeBuildTriggerType will trigger a build on an initial build config creation WARNING: In the future the behavior will change to trigger a build on any config change 2.1.40. .spec.triggers[].bitbucket Description WebHookTrigger is a trigger that gets invoked using a webhook type of post Type object Property Type Description allowEnv boolean allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook. secret string secret used to validate requests. Deprecated: use SecretReference instead. secretReference object SecretLocalReference contains information that points to the local secret being used 2.1.41. .spec.triggers[].bitbucket.secretReference Description SecretLocalReference contains information that points to the local secret being used Type object Required name Property Type Description name string Name is the name of the resource in the same namespace being referenced 2.1.42. .spec.triggers[].generic Description WebHookTrigger is a trigger that gets invoked using a webhook type of post Type object Property Type Description allowEnv boolean allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook. secret string secret used to validate requests. Deprecated: use SecretReference instead. secretReference object SecretLocalReference contains information that points to the local secret being used 2.1.43. .spec.triggers[].generic.secretReference Description SecretLocalReference contains information that points to the local secret being used Type object Required name Property Type Description name string Name is the name of the resource in the same namespace being referenced 2.1.44. .spec.triggers[].github Description WebHookTrigger is a trigger that gets invoked using a webhook type of post Type object Property Type Description allowEnv boolean allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook. secret string secret used to validate requests. Deprecated: use SecretReference instead. secretReference object SecretLocalReference contains information that points to the local secret being used 2.1.45. .spec.triggers[].github.secretReference Description SecretLocalReference contains information that points to the local secret being used Type object Required name Property Type Description name string Name is the name of the resource in the same namespace being referenced 2.1.46. .spec.triggers[].gitlab Description WebHookTrigger is a trigger that gets invoked using a webhook type of post Type object Property Type Description allowEnv boolean allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook. secret string secret used to validate requests. Deprecated: use SecretReference instead. secretReference object SecretLocalReference contains information that points to the local secret being used 2.1.47. .spec.triggers[].gitlab.secretReference Description SecretLocalReference contains information that points to the local secret being used Type object Required name Property Type Description name string Name is the name of the resource in the same namespace being referenced 2.1.48. .spec.triggers[].imageChange Description ImageChangeTrigger allows builds to be triggered when an ImageStream changes Type object Property Type Description from ObjectReference from is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration. lastTriggeredImageID string lastTriggeredImageID is used internally by the ImageChangeController to save last used image ID for build This field is deprecated and will be removed in a future release. Deprecated paused boolean paused is true if this trigger is temporarily disabled. Optional. 2.1.49. .status Description BuildConfigStatus contains current state of the build config object. Type object Required lastVersion Property Type Description imageChangeTriggers array ImageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec, including the value reconciled by the OpenShift APIServer for the lastTriggeredImageID. There is a single entry in this array for each image change trigger in spec. Each trigger status references the ImageStreamTag that acts as the source of the trigger. imageChangeTriggers[] object ImageChangeTriggerStatus tracks the latest resolved status of the associated ImageChangeTrigger policy specified in the BuildConfigSpec.Triggers struct. lastVersion integer lastVersion is used to inform about number of last triggered build. 2.1.50. .status.imageChangeTriggers Description ImageChangeTriggers captures the runtime state of any ImageChangeTrigger specified in the BuildConfigSpec, including the value reconciled by the OpenShift APIServer for the lastTriggeredImageID. There is a single entry in this array for each image change trigger in spec. Each trigger status references the ImageStreamTag that acts as the source of the trigger. Type array 2.1.51. .status.imageChangeTriggers[] Description ImageChangeTriggerStatus tracks the latest resolved status of the associated ImageChangeTrigger policy specified in the BuildConfigSpec.Triggers struct. Type object Property Type Description from object ImageStreamTagReference references the ImageStreamTag in an image change trigger by namespace and name. lastTriggerTime Time lastTriggerTime is the last time this particular ImageStreamTag triggered a Build to start. This field is only updated when this trigger specifically started a Build. lastTriggeredImageID string lastTriggeredImageID represents the sha/id of the ImageStreamTag when a Build for this BuildConfig was started. The lastTriggeredImageID is updated each time a Build for this BuildConfig is started, even if this ImageStreamTag is not the reason the Build is started. 2.1.52. .status.imageChangeTriggers[].from Description ImageStreamTagReference references the ImageStreamTag in an image change trigger by namespace and name. Type object Property Type Description name string name is the name of the ImageStreamTag for an ImageChangeTrigger namespace string namespace is the namespace where the ImageStreamTag for an ImageChangeTrigger is located 2.2. API endpoints The following API endpoints are available: /apis/build.openshift.io/v1/buildconfigs GET : list or watch objects of kind BuildConfig /apis/build.openshift.io/v1/watch/buildconfigs GET : watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs DELETE : delete collection of BuildConfig GET : list or watch objects of kind BuildConfig POST : create a BuildConfig /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs GET : watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name} DELETE : delete a BuildConfig GET : read the specified BuildConfig PATCH : partially update the specified BuildConfig PUT : replace the specified BuildConfig /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs/{name} GET : watch changes to an object of kind BuildConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. 2.2.1. /apis/build.openshift.io/v1/buildconfigs Table 2.1. Global query parameters Parameter Type Description allowWatchBookmarks boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. pretty string If 'true', then the output is pretty printed. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. HTTP method GET Description list or watch objects of kind BuildConfig Table 2.2. HTTP responses HTTP code Reponse body 200 - OK BuildConfigList schema 401 - Unauthorized Empty 2.2.2. /apis/build.openshift.io/v1/watch/buildconfigs Table 2.3. Global query parameters Parameter Type Description allowWatchBookmarks boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. pretty string If 'true', then the output is pretty printed. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. HTTP method GET Description watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. Table 2.4. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 2.2.3. /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs Table 2.5. Global path parameters Parameter Type Description namespace string object name and auth scope, such as for teams and projects Table 2.6. Global query parameters Parameter Type Description pretty string If 'true', then the output is pretty printed. HTTP method DELETE Description delete collection of BuildConfig Table 2.7. Query parameters Parameter Type Description continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. gracePeriodSeconds integer The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. orphanDependents boolean Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. propagationPolicy string Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. Table 2.8. Body parameters Parameter Type Description body DeleteOptions schema Table 2.9. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list or watch objects of kind BuildConfig Table 2.10. Query parameters Parameter Type Description allowWatchBookmarks boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. Table 2.11. HTTP responses HTTP code Reponse body 200 - OK BuildConfigList schema 401 - Unauthorized Empty HTTP method POST Description create a BuildConfig Table 2.12. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager string fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint . fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 2.13. Body parameters Parameter Type Description body BuildConfig schema Table 2.14. HTTP responses HTTP code Reponse body 200 - OK BuildConfig schema 201 - Created BuildConfig schema 202 - Accepted BuildConfig schema 401 - Unauthorized Empty 2.2.4. /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs Table 2.15. Global path parameters Parameter Type Description namespace string object name and auth scope, such as for teams and projects Table 2.16. Global query parameters Parameter Type Description allowWatchBookmarks boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. pretty string If 'true', then the output is pretty printed. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. HTTP method GET Description watch individual changes to a list of BuildConfig. deprecated: use the 'watch' parameter with a list operation instead. Table 2.17. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty 2.2.5. /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name} Table 2.18. Global path parameters Parameter Type Description name string name of the BuildConfig namespace string object name and auth scope, such as for teams and projects Table 2.19. Global query parameters Parameter Type Description pretty string If 'true', then the output is pretty printed. HTTP method DELETE Description delete a BuildConfig Table 2.20. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed gracePeriodSeconds integer The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. orphanDependents boolean Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. propagationPolicy string Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. Table 2.21. Body parameters Parameter Type Description body DeleteOptions schema Table 2.22. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified BuildConfig Table 2.23. HTTP responses HTTP code Reponse body 200 - OK BuildConfig schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified BuildConfig Table 2.24. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager string fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint . This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. force boolean Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. Table 2.25. Body parameters Parameter Type Description body Patch schema Table 2.26. HTTP responses HTTP code Reponse body 200 - OK BuildConfig schema 201 - Created BuildConfig schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified BuildConfig Table 2.27. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldManager string fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint . fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 2.28. Body parameters Parameter Type Description body BuildConfig schema Table 2.29. HTTP responses HTTP code Reponse body 200 - OK BuildConfig schema 201 - Created BuildConfig schema 401 - Unauthorized Empty 2.2.6. /apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs/{name} Table 2.30. Global path parameters Parameter Type Description name string name of the BuildConfig namespace string object name and auth scope, such as for teams and projects Table 2.31. Global query parameters Parameter Type Description allowWatchBookmarks boolean allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. continue string The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the key, but from the latest snapshot, which is inconsistent from the list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the " key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. fieldSelector string A selector to restrict the list of returned objects by their fields. Defaults to everything. labelSelector string A selector to restrict the list of returned objects by their labels. Defaults to everything. limit integer limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. pretty string If 'true', then the output is pretty printed. resourceVersion string resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset resourceVersionMatch string resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset sendInitialEvents boolean sendInitialEvents=true may be set together with watch=true . In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic "Bookmark" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with "k8s.io/initial-events-end": "true" annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched. When sendInitialEvents option is set, we require resourceVersionMatch option to also be set. The semantic of the watch request is as following: - resourceVersionMatch = NotOlderThan is interpreted as "data at least as new as the provided resourceVersion`" and the bookmark event is send when the state is synced to a `resourceVersion at least as fresh as the one provided by the ListOptions. If resourceVersion is unset, this is interpreted as "consistent read" and the bookmark event is send when the state is synced at least to the moment when request started being processed. - resourceVersionMatch set to any other value or unset Invalid error is returned. Defaults to true if resourceVersion="" or resourceVersion="0" (for backward compatibility reasons) and to false otherwise. timeoutSeconds integer Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. watch boolean Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. HTTP method GET Description watch changes to an object of kind BuildConfig. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. Table 2.32. HTTP responses HTTP code Reponse body 200 - OK WatchEvent schema 401 - Unauthorized Empty
[ "\"postCommit\": { \"script\": \"rake test --verbose\", }", "The above is a convenient form which is equivalent to:", "\"postCommit\": { \"command\": [\"/bin/sh\", \"-ic\"], \"args\": [\"rake test --verbose\"] }", "\"postCommit\": { \"commit\": [\"rake\", \"test\", \"--verbose\"] }", "Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.", "\"postCommit\": { \"args\": [\"rake\", \"test\", \"--verbose\"] }", "This form is only useful if the image entrypoint can handle arguments.", "\"postCommit\": { \"script\": \"rake test USD1\", \"args\": [\"--verbose\"] }", "This form is useful if you need to pass arguments that would otherwise be hard to quote properly in the shell script. In the script, USD0 will be \"/bin/sh\" and USD1, USD2, etc, are the positional arguments from Args.", "\"postCommit\": { \"command\": [\"rake\", \"test\"], \"args\": [\"--verbose\"] }", "This form is equivalent to appending the arguments to the Command slice." ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.14/html/workloads_apis/buildconfig-build-openshift-io-v1
Appendix G. Kafka Streams configuration parameters
Appendix G. Kafka Streams configuration parameters application.id Type: string Importance: high An identifier for the stream processing application. Must be unique within the Kafka cluster. It is used as 1) the default client-id prefix, 2) the group-id for membership management, 3) the changelog topic prefix. bootstrap.servers Type: list Importance: high A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping-this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form host1:port1,host2:port2,... . Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). num.standby.replicas Type: int Default: 0 Importance: high The number of standby replicas for each task. state.dir Type: string Default: /tmp/kafka-streams Importance: high Directory location for state store. This path must be unique for each streams instance sharing the same underlying filesystem. acceptable.recovery.lag Type: long Default: 10000 Valid Values: [0,... ] Importance: medium The maximum acceptable lag (number of offsets to catch up) for a client to be considered caught-up for an active task.Should correspond to a recovery time of well under a minute for a given workload. Must be at least 0. cache.max.bytes.buffering Type: long Default: 10485760 Valid Values: [0,... ] Importance: medium Maximum number of memory bytes to be used for buffering across all threads. client.id Type: string Default: "" Importance: medium An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer, with pattern '<client.id>-StreamThread-<threadSequenceNumber>-<consumer|producer|restore-consumer>'. default.deserialization.exception.handler Type: class Default: org.apache.kafka.streams.errors.LogAndFailExceptionHandler Importance: medium Exception handling class that implements the org.apache.kafka.streams.errors.DeserializationExceptionHandler interface. default.key.serde Type: class Default: null Importance: medium Default serializer / deserializer class for key that implements the org.apache.kafka.common.serialization.Serde interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well. default.list.key.serde.inner Type: class Default: null Importance: medium Default inner class of list serde for key that implements the org.apache.kafka.common.serialization.Serde interface. This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde . default.list.key.serde.type Type: class Default: null Importance: medium Default class for key that implements the java.util.List interface. This configuration will be read if and only if default.key.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.key.serde.inner'. default.list.value.serde.inner Type: class Default: null Importance: medium Default inner class of list serde for value that implements the org.apache.kafka.common.serialization.Serde interface. This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde . default.list.value.serde.type Type: class Default: null Importance: medium Default class for value that implements the java.util.List interface. This configuration will be read if and only if default.value.serde configuration is set to org.apache.kafka.common.serialization.Serdes.ListSerde Note when list serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.list.value.serde.inner'. default.production.exception.handler Type: class Default: org.apache.kafka.streams.errors.DefaultProductionExceptionHandler Importance: medium Exception handling class that implements the org.apache.kafka.streams.errors.ProductionExceptionHandler interface. default.timestamp.extractor Type: class Default: org.apache.kafka.streams.processor.FailOnInvalidTimestamp Importance: medium Default timestamp extractor class that implements the org.apache.kafka.streams.processor.TimestampExtractor interface. default.value.serde Type: class Default: null Importance: medium Default serializer / deserializer class for value that implements the org.apache.kafka.common.serialization.Serde interface. Note when windowed serde class is used, one needs to set the inner serde class that implements the org.apache.kafka.common.serialization.Serde interface via 'default.windowed.key.serde.inner' or 'default.windowed.value.serde.inner' as well. max.task.idle.ms Type: long Default: 0 Importance: medium This config controls whether joins and merges may produce out-of-order results. The config value is the maximum amount of time in milliseconds a stream task will stay idle when it is fully caught up on some (but not all) input partitions to wait for producers to send additional records and avoid potential out-of-order record processing across multiple input streams. The default (zero) does not wait for producers to send more records, but it does wait to fetch data that is already present on the brokers. This default means that for records that are already present on the brokers, Streams will process them in timestamp order. Set to -1 to disable idling entirely and process any locally available data, even though doing so may produce out-of-order processing. max.warmup.replicas Type: int Default: 2 Valid Values: [1,... ] Importance: medium The maximum number of warmup replicas (extra standbys beyond the configured num.standbys) that can be assigned at once for the purpose of keeping the task available on one instance while it is warming up on another instance it has been reassigned to. Used to throttle how much extra broker traffic and cluster state can be used for high availability. Must be at least 1. num.stream.threads Type: int Default: 1 Importance: medium The number of threads to execute stream processing. processing.guarantee Type: string Default: at_least_once Valid Values: [at_least_once, exactly_once, exactly_once_beta, exactly_once_v2] Importance: medium The processing guarantee that should be used. Possible values are at_least_once (default) and exactly_once_v2 (requires brokers version 2.5 or higher). Deprecated options are exactly_once (requires brokers version 0.11.0 or higher) and exactly_once_beta (requires brokers version 2.5 or higher). Note that exactly-once processing requires a cluster of at least three brokers by default what is the recommended setting for production; for development you can change this, by adjusting broker setting transaction.state.log.replication.factor and transaction.state.log.min.isr . replication.factor Type: int Default: -1 Importance: medium The replication factor for change log topics and repartition topics created by the stream processing application. The default of -1 (meaning: use broker default replication factor) requires broker version 2.4 or newer. security.protocol Type: string Default: PLAINTEXT Importance: medium Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL, SASL_PLAINTEXT, SASL_SSL. task.timeout.ms Type: long Default: 300000 (5 minutes) Valid Values: [0,... ] Importance: medium The maximum amount of time in milliseconds a task might stall due to internal errors and retries until an error is raised. For a timeout of 0ms, a task would raise an error for the first internal error. For any timeout larger than 0ms, a task will retry at least once before an error is raised. topology.optimization Type: string Default: none Valid Values: [none, all] Importance: medium A configuration telling Kafka Streams if it should optimize the topology, disabled by default. application.server Type: string Default: "" Importance: low A host:port pair pointing to a user-defined endpoint that can be used for state store discovery and interactive queries on this KafkaStreams instance. buffered.records.per.partition Type: int Default: 1000 Importance: low Maximum number of records to buffer per partition. built.in.metrics.version Type: string Default: latest Valid Values: [latest] Importance: low Version of the built-in metrics to use. commit.interval.ms Type: long Default: 30000 (30 seconds) Valid Values: [0,... ] Importance: low The frequency in milliseconds with which to save the position of the processor. (Note, if processing.guarantee is set to exactly_once_v2 , exactly_once ,the default value is 100 , otherwise the default value is 30000 . connections.max.idle.ms Type: long Default: 540000 (9 minutes) Importance: low Close idle connections after the number of milliseconds specified by this config. metadata.max.age.ms Type: long Default: 300000 (5 minutes) Valid Values: [0,... ] Importance: low The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions. metric.reporters Type: list Default: "" Importance: low A list of classes to use as metrics reporters. Implementing the org.apache.kafka.common.metrics.MetricsReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics. metrics.num.samples Type: int Default: 2 Valid Values: [1,... ] Importance: low The number of samples maintained to compute metrics. metrics.recording.level Type: string Default: INFO Valid Values: [INFO, DEBUG, TRACE] Importance: low The highest recording level for metrics. metrics.sample.window.ms Type: long Default: 30000 (30 seconds) Valid Values: [0,... ] Importance: low The window of time a metrics sample is computed over. poll.ms Type: long Default: 100 Importance: low The amount of time in milliseconds to block waiting for input. probing.rebalance.interval.ms Type: long Default: 600000 (10 minutes) Valid Values: [60000,... ] Importance: low The maximum time in milliseconds to wait before triggering a rebalance to probe for warmup replicas that have finished warming up and are ready to become active. Probing rebalances will continue to be triggered until the assignment is balanced. Must be at least 1 minute. receive.buffer.bytes Type: int Default: 32768 (32 kibibytes) Valid Values: [-1,... ] Importance: low The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. If the value is -1, the OS default will be used. reconnect.backoff.max.ms Type: long Default: 1000 (1 second) Valid Values: [0,... ] Importance: low The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms. reconnect.backoff.ms Type: long Default: 50 Valid Values: [0,... ] Importance: low The base amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all connection attempts by the client to a broker. request.timeout.ms Type: int Default: 40000 (40 seconds) Valid Values: [0,... ] Importance: low The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted. retries Type: int Default: 0 Valid Values: [0,... ,2147483647] Importance: low Setting a value greater than zero will cause the client to resend any request that fails with a potentially transient error. It is recommended to set the value to either zero or MAX_VALUE and use corresponding timeout parameters to control how long a client should retry a request. retry.backoff.ms Type: long Default: 100 Valid Values: [0,... ] Importance: low The amount of time to wait before attempting to retry a failed request to a given topic partition. This avoids repeatedly sending requests in a tight loop under some failure scenarios. rocksdb.config.setter Type: class Default: null Importance: low A Rocks DB config setter class or class name that implements the org.apache.kafka.streams.state.RocksDBConfigSetter interface. send.buffer.bytes Type: int Default: 131072 (128 kibibytes) Valid Values: [-1,... ] Importance: low The size of the TCP send buffer (SO_SNDBUF) to use when sending data. If the value is -1, the OS default will be used. state.cleanup.delay.ms Type: long Default: 600000 (10 minutes) Importance: low The amount of time in milliseconds to wait before deleting state when a partition has migrated. Only state directories that have not been modified for at least state.cleanup.delay.ms will be removed. upgrade.from Type: string Default: null Valid Values: [null, 0.10.0, 0.10.1, 0.10.2, 0.11.0, 1.0, 1.1, 2.0, 2.1, 2.2, 2.3] Importance: low Allows upgrading in a backward compatible way. This is needed when upgrading from [0.10.0, 1.1] to 2.0+, or when upgrading from [2.0, 2.3] to 2.4+. When upgrading from 2.4 to a newer version it is not required to specify this config. Default is null . Accepted values are "0.10.0", "0.10.1", "0.10.2", "0.11.0", "1.0", "1.1", "2.0", "2.1", "2.2", "2.3" (for upgrading from the corresponding old version). window.size.ms Type: long Default: null Importance: low Sets window size for the deserializer in order to calculate window end times. windowed.inner.class.serde Type: string Default: null Importance: low Default serializer / deserializer for the inner class of a windowed record. Must implement the " "`org.apache.kafka.common.serialization.Serde` interface.. Note that setting this config in KafkaStreams application would result in an error as it is meant to be used only from Plain consumer client. windowstore.changelog.additional.retention.ms Type: long Default: 86400000 (1 day) Importance: low Added to a windows maintainMs to ensure data is not deleted from the log prematurely. Allows for clock drift. Default is 1 day.
null
https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.1/html/using_amq_streams_on_rhel/kafka-streams-configuration-parameters-str
Automation Content Navigator Creator Guide
Automation Content Navigator Creator Guide Red Hat Ansible Automation Platform 2.3 Develop content that is compatible with Ansible Automation Platform Red Hat Customer Content Services
null
https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.3/html/automation_content_navigator_creator_guide/index
Cluster Observability Operator
Cluster Observability Operator OpenShift Container Platform 4.12 Configuring and using the Cluster Observability Operator in OpenShift Container Platform Red Hat OpenShift Documentation Team
[ "apiVersion: monitoring.rhobs/v1alpha1 kind: MonitoringStack metadata: labels: coo: example name: sample-monitoring-stack namespace: coo-demo spec: logLevel: debug retention: 1d resourceSelector: matchLabels: app: demo", "oc -n coo-demo get Prometheus.monitoring.rhobs -oyaml --show-managed-fields", "managedFields: - apiVersion: monitoring.rhobs/v1 fieldsType: FieldsV1 fieldsV1: f:metadata: f:labels: f:app.kubernetes.io/managed-by: {} f:app.kubernetes.io/name: {} f:app.kubernetes.io/part-of: {} f:ownerReferences: k:{\"uid\":\"81da0d9a-61aa-4df3-affc-71015bcbde5a\"}: {} f:spec: f:additionalScrapeConfigs: {} f:affinity: f:podAntiAffinity: f:requiredDuringSchedulingIgnoredDuringExecution: {} f:alerting: f:alertmanagers: {} f:arbitraryFSAccessThroughSMs: {} f:logLevel: {} f:podMetadata: f:labels: f:app.kubernetes.io/component: {} f:app.kubernetes.io/part-of: {} f:podMonitorSelector: {} f:replicas: {} f:resources: f:limits: f:cpu: {} f:memory: {} f:requests: f:cpu: {} f:memory: {} f:retention: {} f:ruleSelector: {} f:rules: f:alert: {} f:securityContext: f:fsGroup: {} f:runAsNonRoot: {} f:runAsUser: {} f:serviceAccountName: {} f:serviceMonitorSelector: {} f:thanos: f:baseImage: {} f:resources: {} f:version: {} f:tsdb: {} manager: observability-operator operation: Apply - apiVersion: monitoring.rhobs/v1 fieldsType: FieldsV1 fieldsV1: f:status: .: {} f:availableReplicas: {} f:conditions: .: {} k:{\"type\":\"Available\"}: .: {} f:lastTransitionTime: {} f:observedGeneration: {} f:status: {} f:type: {} k:{\"type\":\"Reconciled\"}: .: {} f:lastTransitionTime: {} f:observedGeneration: {} f:status: {} f:type: {} f:paused: {} f:replicas: {} f:shardStatuses: .: {} k:{\"shardID\":\"0\"}: .: {} f:availableReplicas: {} f:replicas: {} f:shardID: {} f:unavailableReplicas: {} f:updatedReplicas: {} f:unavailableReplicas: {} f:updatedReplicas: {} manager: PrometheusOperator operation: Update subresource: status", "apiVersion: monitoring.rhobs/v1 kind: Prometheus metadata: name: sample-monitoring-stack namespace: coo-demo spec: enforcedSampleLimit: 1000", "oc apply -f ./prom-spec-edited.yaml --server-side", "oc get prometheus -n coo-demo", "managedFields: 1 - apiVersion: monitoring.rhobs/v1 fieldsType: FieldsV1 fieldsV1: f:metadata: f:labels: f:app.kubernetes.io/managed-by: {} f:app.kubernetes.io/name: {} f:app.kubernetes.io/part-of: {} f:spec: f:enforcedSampleLimit: {} 2 manager: kubectl operation: Apply", "changing the logLevel from debug to info apiVersion: monitoring.rhobs/v1 kind: Prometheus metadata: name: sample-monitoring-stack namespace: coo-demo spec: logLevel: info 1", "oc apply -f ./prom-spec-edited.yaml --server-side", "error: Apply failed with 1 conflict: conflict with \"observability-operator\": .spec.logLevel Please review the fields above--they currently have other managers. Here are the ways you can resolve this warning: * If you intend to manage all of these fields, please re-run the apply command with the `--force-conflicts` flag. * If you do not intend to manage all of the fields, please edit your manifest to remove references to the fields that should keep their current managers. * You may co-own fields by updating your manifest to match the existing value; in this case, you'll become the manager if the other manager(s) stop managing the field (remove it from their configuration). See https://kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts", "oc apply -f ./prom-spec-edited.yaml --server-side --force-conflicts", "prometheus.monitoring.rhobs/sample-monitoring-stack serverside-applied", "apiVersion: monitoring.rhobs/v1alpha1 kind: MonitoringStack metadata: name: sample-monitoring-stack labels: coo: example spec: logLevel: info", "oc -n coo-demo get Prometheus.monitoring.rhobs -o=jsonpath='{.items[0].spec.logLevel}'", "info", "apiVersion: v1 kind: Namespace metadata: name: ns1-coo --- apiVersion: apps/v1 kind: Deployment metadata: labels: app: prometheus-coo-example-app name: prometheus-coo-example-app namespace: ns1-coo spec: replicas: 1 selector: matchLabels: app: prometheus-coo-example-app template: metadata: labels: app: prometheus-coo-example-app spec: containers: - image: ghcr.io/rhobs/prometheus-example-app:0.4.2 imagePullPolicy: IfNotPresent name: prometheus-coo-example-app --- apiVersion: v1 kind: Service metadata: labels: app: prometheus-coo-example-app name: prometheus-coo-example-app namespace: ns1-coo spec: ports: - port: 8080 protocol: TCP targetPort: 8080 name: web selector: app: prometheus-coo-example-app type: ClusterIP", "oc apply -f prometheus-coo-example-app.yaml", "oc -n ns1-coo get pod", "NAME READY STATUS RESTARTS AGE prometheus-coo-example-app-0927545cb7-anskj 1/1 Running 0 81m", "apiVersion: monitoring.rhobs/v1 kind: ServiceMonitor metadata: labels: k8s-app: prometheus-coo-example-monitor name: prometheus-coo-example-monitor namespace: ns1-coo spec: endpoints: - interval: 30s port: web scheme: http selector: matchLabels: app: prometheus-coo-example-app", "oc apply -f example-coo-app-service-monitor.yaml", "oc -n ns1-coo get servicemonitors.monitoring.rhobs", "NAME AGE prometheus-coo-example-monitor 81m", "apiVersion: monitoring.rhobs/v1alpha1 kind: MonitoringStack metadata: name: example-coo-monitoring-stack namespace: ns1-coo spec: logLevel: debug retention: 1d resourceSelector: matchLabels: k8s-app: prometheus-coo-example-monitor", "oc apply -f example-coo-monitoring-stack.yaml", "oc -n ns1-coo get monitoringstack", "NAME AGE example-coo-monitoring-stack 81m", "oc -n ns1-coo exec -c prometheus prometheus-example-coo-monitoring-stack-0 -- curl -s 'http://localhost:9090/api/v1/targets' | jq '.data.activeTargets[].discoveredLabels | select(.__meta_kubernetes_endpoints_label_app==\"prometheus-coo-example-app\")'", "{ \"__address__\": \"10.129.2.25:8080\", \"__meta_kubernetes_endpoint_address_target_kind\": \"Pod\", \"__meta_kubernetes_endpoint_address_target_name\": \"prometheus-coo-example-app-5d8cd498c7-9j2gj\", \"__meta_kubernetes_endpoint_node_name\": \"ci-ln-8tt8vxb-72292-6cxjr-worker-a-wdfnz\", \"__meta_kubernetes_endpoint_port_name\": \"web\", \"__meta_kubernetes_endpoint_port_protocol\": \"TCP\", \"__meta_kubernetes_endpoint_ready\": \"true\", \"__meta_kubernetes_endpoints_annotation_endpoints_kubernetes_io_last_change_trigger_time\": \"2024-11-05T11:24:09Z\", \"__meta_kubernetes_endpoints_annotationpresent_endpoints_kubernetes_io_last_change_trigger_time\": \"true\", \"__meta_kubernetes_endpoints_label_app\": \"prometheus-coo-example-app\", \"__meta_kubernetes_endpoints_labelpresent_app\": \"true\", \"__meta_kubernetes_endpoints_name\": \"prometheus-coo-example-app\", \"__meta_kubernetes_namespace\": \"ns1-coo\", \"__meta_kubernetes_pod_annotation_k8s_ovn_org_pod_networks\": \"{\\\"default\\\":{\\\"ip_addresses\\\":[\\\"10.129.2.25/23\\\"],\\\"mac_address\\\":\\\"0a:58:0a:81:02:19\\\",\\\"gateway_ips\\\":[\\\"10.129.2.1\\\"],\\\"routes\\\":[{\\\"dest\\\":\\\"10.128.0.0/14\\\",\\\"nextHop\\\":\\\"10.129.2.1\\\"},{\\\"dest\\\":\\\"172.30.0.0/16\\\",\\\"nextHop\\\":\\\"10.129.2.1\\\"},{\\\"dest\\\":\\\"100.64.0.0/16\\\",\\\"nextHop\\\":\\\"10.129.2.1\\\"}],\\\"ip_address\\\":\\\"10.129.2.25/23\\\",\\\"gateway_ip\\\":\\\"10.129.2.1\\\",\\\"role\\\":\\\"primary\\\"}}\", \"__meta_kubernetes_pod_annotation_k8s_v1_cni_cncf_io_network_status\": \"[{\\n \\\"name\\\": \\\"ovn-kubernetes\\\",\\n \\\"interface\\\": \\\"eth0\\\",\\n \\\"ips\\\": [\\n \\\"10.129.2.25\\\"\\n ],\\n \\\"mac\\\": \\\"0a:58:0a:81:02:19\\\",\\n \\\"default\\\": true,\\n \\\"dns\\\": {}\\n}]\", \"__meta_kubernetes_pod_annotation_openshift_io_scc\": \"restricted-v2\", \"__meta_kubernetes_pod_annotation_seccomp_security_alpha_kubernetes_io_pod\": \"runtime/default\", \"__meta_kubernetes_pod_annotationpresent_k8s_ovn_org_pod_networks\": \"true\", \"__meta_kubernetes_pod_annotationpresent_k8s_v1_cni_cncf_io_network_status\": \"true\", \"__meta_kubernetes_pod_annotationpresent_openshift_io_scc\": \"true\", \"__meta_kubernetes_pod_annotationpresent_seccomp_security_alpha_kubernetes_io_pod\": \"true\", \"__meta_kubernetes_pod_controller_kind\": \"ReplicaSet\", \"__meta_kubernetes_pod_controller_name\": \"prometheus-coo-example-app-5d8cd498c7\", \"__meta_kubernetes_pod_host_ip\": \"10.0.128.2\", \"__meta_kubernetes_pod_ip\": \"10.129.2.25\", \"__meta_kubernetes_pod_label_app\": \"prometheus-coo-example-app\", \"__meta_kubernetes_pod_label_pod_template_hash\": \"5d8cd498c7\", \"__meta_kubernetes_pod_labelpresent_app\": \"true\", \"__meta_kubernetes_pod_labelpresent_pod_template_hash\": \"true\", \"__meta_kubernetes_pod_name\": \"prometheus-coo-example-app-5d8cd498c7-9j2gj\", \"__meta_kubernetes_pod_node_name\": \"ci-ln-8tt8vxb-72292-6cxjr-worker-a-wdfnz\", \"__meta_kubernetes_pod_phase\": \"Running\", \"__meta_kubernetes_pod_ready\": \"true\", \"__meta_kubernetes_pod_uid\": \"054c11b6-9a76-4827-a860-47f3a4596871\", \"__meta_kubernetes_service_label_app\": \"prometheus-coo-example-app\", \"__meta_kubernetes_service_labelpresent_app\": \"true\", \"__meta_kubernetes_service_name\": \"prometheus-coo-example-app\", \"__metrics_path__\": \"/metrics\", \"__scheme__\": \"http\", \"__scrape_interval__\": \"30s\", \"__scrape_timeout__\": \"10s\", \"job\": \"serviceMonitor/ns1-coo/prometheus-coo-example-monitor/0\" }", "oc expose svc prometheus-coo-example-app -n ns1-coo", "oc -n ns1-coo exec -c prometheus prometheus-example-coo-monitoring-stack-0 -- curl -s 'http://localhost:9090/api/v1/query?query=http_requests_total'", "{ \"status\": \"success\", \"data\": { \"resultType\": \"vector\", \"result\": [ { \"metric\": { \"__name__\": \"http_requests_total\", \"code\": \"200\", \"endpoint\": \"web\", \"instance\": \"10.129.2.25:8080\", \"job\": \"prometheus-coo-example-app\", \"method\": \"get\", \"namespace\": \"ns1-coo\", \"pod\": \"prometheus-coo-example-app-5d8cd498c7-9j2gj\", \"service\": \"prometheus-coo-example-app\" }, \"value\": [ 1730807483.632, \"3\" ] }, { \"metric\": { \"__name__\": \"http_requests_total\", \"code\": \"404\", \"endpoint\": \"web\", \"instance\": \"10.129.2.25:8080\", \"job\": \"prometheus-coo-example-app\", \"method\": \"get\", \"namespace\": \"ns1-coo\", \"pod\": \"prometheus-coo-example-app-5d8cd498c7-9j2gj\", \"service\": \"prometheus-coo-example-app\" }, \"value\": [ 1730807483.632, \"0\" ] } ] } }", "apiVersion: observability.openshift.io/v1alpha1 kind: UIPlugin metadata: name: logging spec: type: Logging logging: lokiStack: name: logging-loki logsLimit: 50 timeout: 30s", "apiVersion: observability.openshift.io/v1alpha1 kind: UIPlugin metadata: name: distributed-tracing spec: type: DistributedTracing", "apiVersion: observability.openshift.io/v1alpha1 kind: UIPlugin metadata: name: troubleshooting-panel spec: type: TroubleshootingPanel", "apiVersion: apps/v1 kind: Deployment metadata: name: bad-deployment namespace: default 1 spec: selector: matchLabels: app: bad-deployment template: metadata: labels: app: bad-deployment spec: containers: 2 - name: bad-deployment image: quay.io/openshift-logging/vector:5.8" ]
https://docs.redhat.com/en/documentation/openshift_container_platform/4.12/html-single/cluster_observability_operator/index
Chapter 3. Using the command line interface
Chapter 3. Using the command line interface The command line interface (CLI) allows interaction with the message broker by use of an interactive shell. You can manage broker actions, configure messages, add users and roles to files and enter other useful commands by using the CLI. You can use the CLI to interact with the broker in a Bash or Zsh shell, or a custom artemis shell. The same commands are available in each shell. By default, the artemis shell has built-in auto-completion of commands and command parameters. You can add auto-completion of the CLI commands and command parameters to a Bash or Zsh shell also. 3.1. Using the CLI in an artemis shell The artemis shell interface provides auto-completion of commands and parameters that can be used with the artemis command. The shell also reuses the connection information provided, such as the broker URI and login credentials, for subsequent commands that you run in the same shell session. Procedure Switch to the user account you created during installation, for example: USD su - amq-broker Use the artemis command to start the shell, for example: If you want to supply the broker connection details when you start an artemis shell, use the artemis shell command. For example: The credentials and URI provided are reused for any subsequent command run in the shell that requires authentication with a broker. Press Tab to display auto-completion information anywhere in the shell. For example: To display a list of commands available in the artemis shell, press Tab at the shell prompt. To display sub-commands for a command, press Tab after the command. For example, type check and press Tab to display the sub-commands for the check command. The auto-completion information shows that the check command supports three sub-commands: cluster , node and queue . To display auto-completion information for a sub-command, press Tab after the sub-command. For example, type check node and press Tab. If no further auto-completion information is displayed, type -- , for example, check node -- , and press Tab to display the parameters available for the command. 3.2. Configuring auto-completion in a Bash or Zsh shell You can configure auto-completion of CLI commands and command parameters in a Bash or Zsh shell. Procedure Switch to the user account you created during installation, for example: USD su - amq-broker Use the following command to create a command auto-completion script called auto-complete-artemis.sh . To run the auto-complete-artemis.sh , use the following command: To view auto-completion information for the artemis command, type /var/opt/amq-broker/mybroker/artemis and press Tab. A list of commands available for the artemis command is displayed. To view auto-completion information for an available command, press Tab after the command. For example, type /var/opt/amq-broker/mybroker/artemis check node and press Tab. If no further auto-completion information is displayed, type -- , for example, check node -- , and press Tab to display the parameters available for the command. 3.3. Starting broker instances A broker instance is a directory containing all the configuration and runtime data, such as logs and data files. The runtime data is associated with a unique broker process. You can start a broker in the foreground by using the artemis script, as a Linux service, or as a Windows service. 3.3.1. Starting the broker instance After the broker instance is created, you use the artemis run command to start it. Procedure Switch to the user account you created during installation. USD su - amq-broker Use the artemis run command to start the broker instance. The broker starts and displays log output with the following information: The location of the transaction logs and cluster configuration. The type of journal being used for message persistence (AIO in this case). The URI(s) that can accept client connections. By default, port 61616 can accept connections from any of the supported protocols (CORE, MQTT, AMQP, STOMP, HORNETQ, and OPENWIRE). There are separate, individual ports for each protocol as well. The web console is available at http://localhost:8161 . The Jolokia service (JMX over REST) is available at http://localhost:8161/jolokia . 3.3.2. Starting a broker as a Linux service If the broker is installed on Linux, you can run it as a service. Procedure Create a new amq-broker.service file in the /etc/systemd/system/ directory. Copy the following text into the file. Modify the path and user fields according to the information provided during the broker instance creation. In the example below, the user amq-broker starts the broker service installed under the /var/opt/amq-broker/mybroker/ directory. Open a terminal. Enable the broker service using the following command: Run the broker service using the following command: 3.3.3. Starting a broker as a Windows service If the broker is installed on Windows, you can run it as a service. Procedure Open a command prompt to enter the commands Install the broker as a service with the following command: Start the service by using the following command: (Optional) Uninstall the service: 3.4. Stopping broker instances Stop the broker instance manually or configure the broker to shutdown gracefully. 3.4.1. Stopping the broker instance After creating the standalone broker and producing and consuming test messages, you can stop the broker instance. This procedure manually stops the broker, which forcefully closes all client connections. In a production environment, you should configure the broker to stop gracefully so that client connections can be closed properly. Procedure Use the artemis stop command to stop the broker instance: USD /var/opt/amq-broker/mybroker/bin/artemis stop 2018-12-03 14:37:30,630 INFO [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.6.1.amq-720004-redhat-1 [b6c244ef-f1cb-11e8-a2d7-0800271b03bd] stopped, uptime 35 minutes Server stopped! 3.4.2. Stopping a broker instance gracefully A manual shutdown forcefully disconnects all clients after a stop command is entered. As an alternative, configure the broker to shut down gracefully by using the graceful-shutdown-enabled configuration element. When graceful-shutdown-enabled is set to true , no new client connections are allowed after a stop command is entered. However, existing connections are allowed to close on the client-side before the shutdown process is started. The default value for graceful-shutdown-enabled is false . Use the graceful-shutdown-timeout configuration element to set a length of time, in milliseconds, for clients to disconnect before connections are forcefully closed from the broker side. After all connections are closed, the shutdown process is started. One advantage of using graceful-shutdown-timeout is that it prevents client connections from delaying a shutdown. The default value for graceful-shutdown-timeout is -1 , meaning the broker waits indefinitely for clients to disconnect. The following procedure demonstrates how to configure a graceful shutdown that uses a timeout. Procedure Open the configuration file <broker_instance_dir> \etc\broker.xml . Add the graceful-shutdown-enabled configuration element and set the value to true . <configuration> <core> ... <graceful-shutdown-enabled> true </graceful-shutdown-enabled> ... </core> </configuration> Add the graceful-shutdown-timeout configuration element and set a value for the timeout in milliseconds. In the following example, client connections are forcefully closed 30 seconds ( 30000 milliseconds) after the stop command is issued. <configuration> <core> ... <graceful-shutdown-enabled> true </graceful-shutdown-enabled> <graceful-shutdown-timeout> 30000 </graceful-shutdown-timeout> ... </core> </configuration> 3.5. Auditing messages by intercepting packets Intercept packets entering or exiting the broker, to audit packets or filter messages. Interceptors change the packets that they intercept. This makes interceptors powerful, but also potentially dangerous. Develop interceptors to meet your business requirements. Interceptors are protocol specific and must implement the appropriate interface. Interceptors must implement the intercept() method, which returns a boolean value. If the value is true , the message packet continues onward. If false , the process is aborted, no other interceptors are called, and the message packet is not processed further. 3.5.1. Creating interceptors Interceptors can change the packets they intercept. You can create your own incoming and outgoing interceptors. All interceptors are protocol specific and are called for any packet entering or exiting the server respectively. This allows you to create interceptors to meet business requirements such as auditing packets. Interceptors and their dependencies must be placed in the Java classpath of the broker. You can use the <broker_instance_dir> /lib directory because it is part of the classpath by default. The following examples demonstrate how to create an interceptor that checks the size of each packet passed to it. Note The examples implement a specific interface for each protocol. Procedure Implement the appropriate interface and override its intercept() method. If you are using the AMQP protocol, implement the org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor interface. package com.example; import org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage; import org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements AmqpInterceptor { private final int ACCEPTABLE_SIZE = 1024; @Override public boolean intercept(final AMQPMessage message, RemotingConnection connection) { int size = message.getEncodeSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println("This AMQPMessage has an acceptable size."); return true; } return false; } } If you are using Core Protocol, your interceptor must implement the org.apache.artemis.activemq.api.core.Interceptor interface. package com.example; import org.apache.artemis.activemq.api.core.Interceptor; import org.apache.activemq.artemis.core.protocol.core.Packet; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(Packet packet, RemotingConnection connection) throws ActiveMQException { int size = packet.getPacketSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println("This Packet has an acceptable size."); return true; } return false; } } If you are using the MQTT protocol, implement the org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor interface. package com.example; import org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor; import io.netty.handler.codec.mqtt.MqttMessage; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(MqttMessage mqttMessage, RemotingConnection connection) throws ActiveMQException { byte[] msg = (mqttMessage.toString()).getBytes(); int size = msg.length; if (size <= ACCEPTABLE_SIZE) { System.out.println("This MqttMessage has an acceptable size."); return true; } return false; } } If you are using the STOMP protocol, implement the org.apache.activemq.artemis.core.protocol.stomp.StompFrameInterceptor interface. package com.example; import org.apache.activemq.artemis.core.protocol.stomp.StompFrameInterceptor; import org.apache.activemq.artemis.core.protocol.stomp.StompFrame; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(StompFrame stompFrame, RemotingConnection connection) throws ActiveMQException { int size = stompFrame.getEncodedSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println("This StompFrame has an acceptable size."); return true; } return false; } } 3.5.2. Configuring the broker to use interceptors Prerequisites Create an interceptor class and add it (and its dependencies) to the Java classpath of the broker. You can use the <broker_instance_dir> /lib directory since it is part of the classpath by default. Procedure Open <broker_instance_dir> /etc/broker.xml Configure the broker to use an interceptor by adding configuration to <broker_instance_dir> /etc/broker.xml If the interceptor is intended for incoming messages, add its class-name to the list of remoting-incoming-interceptors . <configuration> <core> ... <remoting-incoming-interceptors> <class-name>org.example.MyIncomingInterceptor</class-name> </remoting-incoming-interceptors> ... </core> </configuration> If the interceptor is intended for outgoing messages, add its class-name to the list of remoting-outgoing-interceptors . <configuration> <core> ... <remoting-outgoing-interceptors> <class-name>org.example.MyOutgoingInterceptor</class-name> </remoting-outgoing-interceptors> </core> </configuration> 3.5.3. Interceptors on the client side Clients can use interceptors to intercept packets either sent by the client to the server or by the server to the client. If the broker-side interceptor returns a false value, then no other interceptors are called and the client does not process the packet further. This process happens transparently, unless an outgoing packet is sent in a blocking fashion. In this case, an ActiveMQException is thrown to the caller. The ActiveMQException thrown contains the name of the interceptor that returned the false value. On the server, the client interceptor classes and their dependencies must be added to the Java classpath of the client, to be properly instantiated and invoked. 3.6. Checking the health of brokers, queues and the cluster AMQ Broker includes a command-line utility that enables you to perform various health checks on brokers and queues in your broker topology. If your brokers are clustered, you can also use the utility to check the health of your cluster topology. Procedure See the list of checks that you can run for a particular broker (that is, node ) in your broker topology. USD <broker_instance_dir> /bin/artemis help check node You see output that describes the set of options that you can use with the artemis check node command. NAME artemis check node - Check a node SYNOPSIS artemis check node [--backup] [--clientID <clientID>] [--diskUsage <diskUsage>] [--fail-at-end] [--live] [--memoryUsage <memoryUsage>] [--name <name>] [--password <password>] [--peers <peers>] [--protocol <protocol>] [--silent] [--timeout <timeout>] [--up] [--url <brokerURL>] [--user <user>] [--verbose] OPTIONS --backup Check that the node has a backup --clientID <clientID> ClientID to be associated with connection --diskUsage <diskUsage> Disk usage percentage to check or -1 to use the max-disk-usage --fail-at-end If a particular module check fails, continue the rest of the checks --live Check that the node has a live --memoryUsage <memoryUsage> Memory usage percentage to check --name <name> Name of the target to check --password <password> Password used to connect --peers <peers> Number of peers to check --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent It will disable all the inputs, and it would make a best guess for any required input --timeout <timeout> Time to wait for the check execution, in milliseconds --up Check that the node is started, it is executed by default if there are no other checks --url <brokerURL> URL towards the broker. (default: tcp://localhost:61616) --user <user> User used to connect --verbose Adds more information on the execution For example, check that the disk usage of the local broker is below the maximum disk usage configured for the broker. USD <broker_instance_dir> /bin/artemis check node --url tcp://localhost:61616 --diskUsage -1 Connection brokerURL = tcp://localhost:61616 Running NodeCheck Checking that the disk usage is less then the max-disk-usage ... success Checks run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.065 sec - NodeCheck In the preceding example, specifying a value of -1 for the --diskUsage option means that the utility checks disk usage against the maximum disk usage configured for the broker. The maximum disk usage of a broker is configured using the max-disk-usage parameter in the broker.xml configuration file. The value specified for max-disk-usage represents the percentage of available physical disk space that the broker is allowed to consume. See the list of checks that you can run for a particular queue in your broker topology. USD <broker_instance_dir> /bin/artemis help check queue You see output that describes the set of options that you can use with the artemis check queue command. NAME artemis check queue - Check a queue SYNOPSIS artemis check queue [--browse <browse>] [--clientID <clientID>] [--consume <consume>] [--fail-at-end] [--name <name>] [--password <password>] [--produce <produce>] [--protocol <protocol>] [--silent] [--timeout <timeout>] [--up] [--url <brokerURL>] [--user <user>] [--verbose] OPTIONS --browse <browse> Number of the messages to browse or -1 to check that the queue is browsable --clientID <clientID> ClientID to be associated with connection --consume <consume> Number of the messages to consume or -1 to check that the queue is consumable --fail-at-end If a particular module check fails, continue the rest of the checks --name <name> Name of the target to check --password <password> Password used to connect --produce <produce> Number of the messages to produce --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent It will disable all the inputs, and it would make a best guess for any required input --timeout <timeout> Time to wait for the check execution, in milliseconds --up Check that the queue exists and is not paused, it is executed by default if there are no other checks --url <brokerURL> URL towards the broker. (default: tcp://localhost:61616) --user <user> User used to connect --verbose Adds more information on the execution The utility can execute multiple options with a single command. For example, to check production, browsing, and consumption of 1000 messages on the default helloworld queue on the local broker, use the following command: USD <broker_instance_dir> /bin/artemis check queue --name helloworld --produce 1000 --browse 1000 --consume 1000 Connection brokerURL = tcp://localhost:61616 Running QueueCheck Checking that a producer can send 1000 messages to the queue helloworld ... success Checking that a consumer can browse 1000 messages from the queue helloworld ... success Checking that a consumer can consume 1000 messages from the queue helloworld ... success Checks run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.882 sec - QueueCheck In the preceding example, observe that you did not specify a broker URL when running the queue check. If you do not explicitly specify a URL, the utility uses a default value of tcp://localhost:61616 . If your brokers are clustered, see the list of checks that you can run for the cluster topology. USD <broker_instance_dir> /bin/artemis help check cluster You see output that describes the set of options that you can use with the artemis check cluster command. NAME artemis check cluster - Verify if all the nodes on the cluster match the same topology and time configuration. SYNOPSIS artemis check cluster [--acceptor=<acceptor>] [--clientID=<clientID>] [--password=<password>] [--protocol=<protocol>] [--silent] [--url=<brokerURL>] [--user=<user>] [--variance=<variance>] [--verbose] OPTIONS --acceptor=<acceptor> Name used to find the default connection URL on the acceptor list. If an acceptor with that name cannot be found, the command looks for a connector with the same name. --clientID <clientID> ClientID to be associated with connection. --password <password> Password used to connect. --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent Disables all the input options and make a best guess for any required input. --url <brokerURL> URL of the broker (default: tcp://localhost:61616). --user <user> User used to connect. --variance <variance> Allowed time variance in milliseconds after which check is deemed to have failed (default=1000). --verbose Adds more information on the execution. 3.7. Command line tools AMQ Broker includes a set of command line interface (CLI) tools, so you can manage your messaging journal. The table below lists the name for each tool and its corresponding description. Table 3.1. Command line tools Tool Description address Addresses tool groups (create/delete/update/show) (example ./artemis address create ). browser Browses messages on an instance. consumer Consumes messages on an instance. data Prints reports about journal records and compacts the data. decode Imports the internal journal format from encode. encode Shows an internal format of the journal encoded to String. exp Exports the message data using a special and independent XML format. help Displays help information. imp Imports the journal to a running broker using the output provided by exp . kill Kills a broker instance started with --allow-kill. mask Masks a password and prints it out. perf-journal Calculates the journal-buffer timeout you should use with the current data folder. queue Queues tool groups (create/delete/update/stat) (example ./artemis queue create ). run Runs the broker instance. stop Stops the broker instance. user Default file-based user managament (add/rm/list/reset) (example ./artemis user list ) For a full list of commands available for each tool, use the help parameter followed by the tool's name. For instance, in the example below, the CLI output lists all the commands available to the data tool after the user enters the command ./artemis help data . You can use the help parameter for more information on how to execute each of the commands. For example, the CLI lists more information about the data print command after the user enters the ./artemis help data print .
[ "su - amq-broker", "/var/opt/amq-broker/mybroker/bin/artemis", "/var/opt/amq-broker/mybroker/bin/artemis shell --user myuser --password mypassword --url tcp://localhost:61616", "su - amq-broker", "/var/opt/amq-broker/mybroker/bin/artemis auto-complete", "source /var/opt/amq-broker/mybroker/bin/artemis/auto-complete-artemis.sh", "su - amq-broker", "/var/opt/amq-broker/mybroker/bin/artemis run __ __ ____ ____ _ /\\ | \\/ |/ __ \\ | _ \\ | | / \\ | \\ / | | | | | |_) |_ __ ___ | | _____ _ __ / /\\ \\ | |\\/| | | | | | _ <| '__/ _ \\| |/ / _ \\ '__| / ____ \\| | | | |__| | | |_) | | | (_) | < __/ | /_/ \\_\\_| |_|\\___\\_\\ |____/|_| \\___/|_|\\_\\___|_| Red Hat JBoss AMQ 7.2.1.GA 10:53:43,959 INFO [org.apache.activemq.artemis.integration.bootstrap] AMQ101000: Starting ActiveMQ Artemis Server 10:53:44,076 INFO [org.apache.activemq.artemis.core.server] AMQ221000: live Message Broker is starting with configuration Broker Configuration (clustered=false,journalDirectory=./data/journal,bindingsDirectory=./data/bindings,largeMessagesDirectory=./data/large-messages,pagingDirectory=./data/paging) 10:53:44,099 INFO [org.apache.activemq.artemis.core.server] AMQ221012: Using AIO Journal", "[Unit] Description=AMQ Broker After=syslog.target network.target [Service] ExecStart=/var/opt/amq-broker/mybroker/bin/artemis run Restart=on-failure User=amq-broker Group=amq-broker A workaround for Java signal handling SuccessExitStatus=143 [Install] WantedBy=multi-user.target", "sudo systemctl enable amq-broker", "sudo systemctl start amq-broker", "<broker_instance_dir> \\bin\\artemis-service.exe install", "<broker_instance_dir> \\bin\\artemis-service.exe start", "<broker_instance_dir> \\bin\\artemis-service.exe uninstall", "/var/opt/amq-broker/mybroker/bin/artemis stop 2018-12-03 14:37:30,630 INFO [org.apache.activemq.artemis.core.server] AMQ221002: Apache ActiveMQ Artemis Message Broker version 2.6.1.amq-720004-redhat-1 [b6c244ef-f1cb-11e8-a2d7-0800271b03bd] stopped, uptime 35 minutes Server stopped!", "<configuration> <core> <graceful-shutdown-enabled> true </graceful-shutdown-enabled> </core> </configuration>", "<configuration> <core> <graceful-shutdown-enabled> true </graceful-shutdown-enabled> <graceful-shutdown-timeout> 30000 </graceful-shutdown-timeout> </core> </configuration>", "package com.example; import org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage; import org.apache.activemq.artemis.protocol.amqp.broker.AmqpInterceptor; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements AmqpInterceptor { private final int ACCEPTABLE_SIZE = 1024; @Override public boolean intercept(final AMQPMessage message, RemotingConnection connection) { int size = message.getEncodeSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println(\"This AMQPMessage has an acceptable size.\"); return true; } return false; } }", "package com.example; import org.apache.artemis.activemq.api.core.Interceptor; import org.apache.activemq.artemis.core.protocol.core.Packet; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(Packet packet, RemotingConnection connection) throws ActiveMQException { int size = packet.getPacketSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println(\"This Packet has an acceptable size.\"); return true; } return false; } }", "package com.example; import org.apache.activemq.artemis.core.protocol.mqtt.MQTTInterceptor; import io.netty.handler.codec.mqtt.MqttMessage; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(MqttMessage mqttMessage, RemotingConnection connection) throws ActiveMQException { byte[] msg = (mqttMessage.toString()).getBytes(); int size = msg.length; if (size <= ACCEPTABLE_SIZE) { System.out.println(\"This MqttMessage has an acceptable size.\"); return true; } return false; } }", "package com.example; import org.apache.activemq.artemis.core.protocol.stomp.StompFrameInterceptor; import org.apache.activemq.artemis.core.protocol.stomp.StompFrame; import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection; public class MyInterceptor implements Interceptor { private final int ACCEPTABLE_SIZE = 1024; @Override boolean intercept(StompFrame stompFrame, RemotingConnection connection) throws ActiveMQException { int size = stompFrame.getEncodedSize(); if (size <= ACCEPTABLE_SIZE) { System.out.println(\"This StompFrame has an acceptable size.\"); return true; } return false; } }", "<configuration> <core> <remoting-incoming-interceptors> <class-name>org.example.MyIncomingInterceptor</class-name> </remoting-incoming-interceptors> </core> </configuration>", "<configuration> <core> <remoting-outgoing-interceptors> <class-name>org.example.MyOutgoingInterceptor</class-name> </remoting-outgoing-interceptors> </core> </configuration>", "<broker_instance_dir> /bin/artemis help check node", "NAME artemis check node - Check a node SYNOPSIS artemis check node [--backup] [--clientID <clientID>] [--diskUsage <diskUsage>] [--fail-at-end] [--live] [--memoryUsage <memoryUsage>] [--name <name>] [--password <password>] [--peers <peers>] [--protocol <protocol>] [--silent] [--timeout <timeout>] [--up] [--url <brokerURL>] [--user <user>] [--verbose] OPTIONS --backup Check that the node has a backup --clientID <clientID> ClientID to be associated with connection --diskUsage <diskUsage> Disk usage percentage to check or -1 to use the max-disk-usage --fail-at-end If a particular module check fails, continue the rest of the checks --live Check that the node has a live --memoryUsage <memoryUsage> Memory usage percentage to check --name <name> Name of the target to check --password <password> Password used to connect --peers <peers> Number of peers to check --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent It will disable all the inputs, and it would make a best guess for any required input --timeout <timeout> Time to wait for the check execution, in milliseconds --up Check that the node is started, it is executed by default if there are no other checks --url <brokerURL> URL towards the broker. (default: tcp://localhost:61616) --user <user> User used to connect --verbose Adds more information on the execution", "<broker_instance_dir> /bin/artemis check node --url tcp://localhost:61616 --diskUsage -1 Connection brokerURL = tcp://localhost:61616 Running NodeCheck Checking that the disk usage is less then the max-disk-usage ... success Checks run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.065 sec - NodeCheck", "<broker_instance_dir> /bin/artemis help check queue", "NAME artemis check queue - Check a queue SYNOPSIS artemis check queue [--browse <browse>] [--clientID <clientID>] [--consume <consume>] [--fail-at-end] [--name <name>] [--password <password>] [--produce <produce>] [--protocol <protocol>] [--silent] [--timeout <timeout>] [--up] [--url <brokerURL>] [--user <user>] [--verbose] OPTIONS --browse <browse> Number of the messages to browse or -1 to check that the queue is browsable --clientID <clientID> ClientID to be associated with connection --consume <consume> Number of the messages to consume or -1 to check that the queue is consumable --fail-at-end If a particular module check fails, continue the rest of the checks --name <name> Name of the target to check --password <password> Password used to connect --produce <produce> Number of the messages to produce --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent It will disable all the inputs, and it would make a best guess for any required input --timeout <timeout> Time to wait for the check execution, in milliseconds --up Check that the queue exists and is not paused, it is executed by default if there are no other checks --url <brokerURL> URL towards the broker. (default: tcp://localhost:61616) --user <user> User used to connect --verbose Adds more information on the execution", "<broker_instance_dir> /bin/artemis check queue --name helloworld --produce 1000 --browse 1000 --consume 1000 Connection brokerURL = tcp://localhost:61616 Running QueueCheck Checking that a producer can send 1000 messages to the queue helloworld ... success Checking that a consumer can browse 1000 messages from the queue helloworld ... success Checking that a consumer can consume 1000 messages from the queue helloworld ... success Checks run: 3, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.882 sec - QueueCheck", "<broker_instance_dir> /bin/artemis help check cluster", "NAME artemis check cluster - Verify if all the nodes on the cluster match the same topology and time configuration. SYNOPSIS artemis check cluster [--acceptor=<acceptor>] [--clientID=<clientID>] [--password=<password>] [--protocol=<protocol>] [--silent] [--url=<brokerURL>] [--user=<user>] [--variance=<variance>] [--verbose] OPTIONS --acceptor=<acceptor> Name used to find the default connection URL on the acceptor list. If an acceptor with that name cannot be found, the command looks for a connector with the same name. --clientID <clientID> ClientID to be associated with connection. --password <password> Password used to connect. --protocol <protocol> Protocol used. Valid values are amqp or core. Default=core. --silent Disables all the input options and make a best guess for any required input. --url <brokerURL> URL of the broker (default: tcp://localhost:61616). --user <user> User used to connect. --variance <variance> Allowed time variance in milliseconds after which check is deemed to have failed (default=1000). --verbose Adds more information on the execution.", "./artemis help data NAME artemis data - data tools group (print|imp|exp|encode|decode|compact) (example ./artemis data print) SYNOPSIS artemis data artemis data compact [--broker <brokerConfig>] [--verbose] [--paging <paging>] [--journal <journal>] [--large-messages <largeMessges>] [--bindings <binding>] artemis data decode [--broker <brokerConfig>] [--suffix <suffix>] [--verbose] [--paging <paging>] [--prefix <prefix>] [--file-size <size>] [--directory <directory>] --input <input> [--journal <journal>] [--large-messages <largeMessges>] [--bindings <binding>] artemis data encode [--directory <directory>] [--broker <brokerConfig>] [--suffix <suffix>] [--verbose] [--paging <paging>] [--prefix <prefix>] [--file-size <size>] [--journal <journal>] [--large-messages <largeMessges>] [--bindings <binding>] artemis data exp [--broker <brokerConfig>] [--verbose] [--paging <paging>] [--journal <journal>] [--large-messages <largeMessges>] [--bindings <binding>] artemis data imp [--host <host>] [--verbose] [--port <port>] [--password <password>] [--transaction] --input <input> [--user <user>] artemis data print [--broker <brokerConfig>] [--verbose] [--paging <paging>] [--journal <journal>] [--large-messages <largeMessges>] [--bindings <binding>] COMMANDS With no arguments, Display help information print Print data records information (WARNING: don't use while a production server is running)", "./artemis help data print NAME artemis data print - Print data records information (WARNING: don't use while a production server is running) SYNOPSIS artemis data print [--bindings <binding>] [--journal <journal>] [--paging <paging>] OPTIONS --bindings <binding> The folder used for bindings (default ../data/bindings) --journal <journal> The folder used for messages journal (default ../data/journal) --paging <paging> The folder used for paging (default ../data/paging)" ]
https://docs.redhat.com/en/documentation/red_hat_amq_broker/7.12/html/managing_amq_broker/assembly-using-command-line-interface-managing
Chapter 130. KafkaConnector schema reference
Chapter 130. KafkaConnector schema reference Property Description spec The specification of the Kafka Connector. KafkaConnectorSpec status The status of the Kafka Connector. KafkaConnectorStatus
null
https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.5/html/amq_streams_api_reference/type-kafkaconnector-reference
E.2. Metadata Contents
E.2. Metadata Contents The volume group metadata contains: Information about how and when it was created Information about the volume group The volume group information contains: Name and unique id A version number which is incremented whenever the metadata gets updated Any properties, such as: read/write or resizable Any administrative limit on the number of physical volumes and logical volumes it may contain The extent size (in units of sectors which are defined as 512 bytes) An unordered list of physical volumes making up the volume group, each with: Its UUID, used to determine the block device containing it Any properties, such as whether the physical volume is allocatable The offset to the start of the first extent within the physical volume (in sectors) The number of extents An unordered list of logical volumes, each consisting of An ordered list of logical volume segments. For each segment the metadata includes a mapping applied to an ordered list of physical volume segments or logical volume segments
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/logical_volume_manager_administration/metadata_contents
Providing feedback on Red Hat documentation
Providing feedback on Red Hat documentation We appreciate your input on our documentation. Do let us know how we can make it better. To give feedback, create a Bugzilla ticket: Go to the Bugzilla website. In the Component section, choose documentation . Fill in the Description field with your suggestion for improvement. Include a link to the relevant part(s) of documentation. Click Submit Bug .
null
https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/4.14/html/deploying_and_managing_openshift_data_foundation_using_red_hat_openstack_platform/providing-feedback-on-red-hat-documentation_osp
Chapter 21. Ensuring the presence of host-based access control rules in IdM using Ansible playbooks
Chapter 21. Ensuring the presence of host-based access control rules in IdM using Ansible playbooks Ansible is an automation tool used to configure systems, deploy software, and perform rolling updates. It includes support for Identity Management (IdM). Learn more about Identity Management (IdM) host-based access policies and how to define them using Ansible . 21.1. Host-based access control rules in IdM Host-based access control (HBAC) rules define which users or user groups can access which hosts or host groups by using which services or services in a service group. As a system administrator, you can use HBAC rules to achieve the following goals: Limit access to a specified system in your domain to members of a specific user group. Allow only a specific service to be used to access systems in your domain. By default, IdM is configured with a default HBAC rule named allow_all , which means universal access to every host for every user via every relevant service in the entire IdM domain. You can fine-tune access to different hosts by replacing the default allow_all rule with your own set of HBAC rules. For centralized and simplified access control management, you can apply HBAC rules to user groups, host groups, or service groups instead of individual users, hosts, or services. 21.2. Ensuring the presence of an HBAC rule in IdM using an Ansible playbook Follow this procedure to ensure the presence of a host-based access control (HBAC) rule in Identity Management (IdM) using an Ansible playbook. Prerequisites You have configured your Ansible control node to meet the following requirements: You are using Ansible version 2.14 or later. You have installed the ansible-freeipa package. The example assumes that in the ~/ MyPlaybooks / directory, you have created an Ansible inventory file with the fully-qualified domain name (FQDN) of the IdM server. The example assumes that the secret.yml Ansible vault stores your ipaadmin_password . The target node, that is the node on which the ansible-freeipa module is executed, is part of the IdM domain as an IdM client, server or replica. The users and user groups you want to use for your HBAC rule exist in IdM. See Managing user accounts using Ansible playbooks and Ensuring the presence of IdM groups and group members using Ansible playbooks for details. The hosts and host groups to which you want to apply your HBAC rule exist in IdM. See Managing hosts using Ansible playbooks and Managing host groups using Ansible playbooks for details. Procedure Create an inventory file, for example inventory.file , and define ipaserver in it: Create your Ansible playbook file that defines the HBAC policy whose presence you want to ensure. To simplify this step, you can copy and modify the example in the /usr/share/doc/ansible-freeipa/playbooks/hbacrule/ensure-hbacrule-allhosts-present.yml file: Run the playbook: Verification Log in to the IdM Web UI as administrator. Navigate to Policy Host-Based-Access-Control HBAC Test . In the Who tab, select idm_user. In the Accessing tab, select client.idm.example.com . In the Via service tab, select sshd . In the Rules tab, select login . In the Run test tab, click the Run test button. If you see ACCESS GRANTED, the HBAC rule is implemented successfully. Additional resources See the README-hbacsvc.md , README-hbacsvcgroup.md , and README-hbacrule.md files in the /usr/share/doc/ansible-freeipa directory. See the playbooks in the subdirectories of the /usr/share/doc/ansible-freeipa/playbooks directory.
[ "[ipaserver] server.idm.example.com", "--- - name: Playbook to handle hbacrules hosts: ipaserver vars_files: - /home/user_name/MyPlaybooks/secret.yml tasks: # Ensure idm_user can access client.idm.example.com via the sshd service - ipahbacrule: ipaadmin_password: \"{{ ipaadmin_password }}\" name: login user: idm_user host: client.idm.example.com hbacsvc: - sshd state: present", "ansible-playbook --vault-password-file=password_file -v -i path_to_inventory_directory/inventory.file path_to_playbooks_directory/ensure-new-hbacrule-present.yml" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/using_ansible_to_install_and_manage_identity_management/ensuring-the-presence-of-host-based-access-control-rules-in-idm-using-ansible-playbooks_using-ansible-to-install-and-manage-identity-management
Chapter 10. Troubleshooting setting up a cross-forest trust
Chapter 10. Troubleshooting setting up a cross-forest trust Learn more about troubleshooting the process of configuring a cross-forest trust between your Identity Management (IdM) environment and an Active Directory (AD) forest. 10.1. Sequence of events when establishing a cross-forest trust with AD When you use the ipa trust-add command to establish a cross-forest trust with an Active Directory (AD) Domain Controller (DC), the command operates on behalf of the user who ran the command and performs the following actions on the IdM server. If you have trouble establishing a cross-forest trust, you can use this list to help narrow down and troubleshoot your issue. Part 1: The command verifies settings and inputs Verify that the IdM server has the Trust Controller role. Validate the options passed to the ipa trust-add command. Validate the ID range associated with a trusted forest root domain. If you did not specify the ID range type and properties as options to the ipa trust-add command, they are discovered from Active Directory. Part 2: The command attempts to establish a trust to an Active Directory domain Create a separate trust object for each trust direction. Each of the objects get created on both sides (IdM and AD). If you are establishing a one-way trust, only one object is created on each side. The IdM server uses the Samba suite to handle domain controller capabilities for Active Directory and creates a trust object on the target AD PDC: The IdM server establishes a secure connection to the IPCUSD share on the target DC. Since RHEL 8.4, the connection requires at least the SMB3 protocol with Windows Server 2012 and above to ensure the connection is sufficiently secure with AES-based encryption used for the session. The IdM server queries for the presence of the trusted domain object (TDO) using an LSA QueryTrustedDomainInfoByName call. If the TDO is already present, remove it with an LSA DeleteTrustedDomain call. Note This call fails if the AD user account used to establish the trust does not have full Enterprise Admin (EA) or Domain Admin (DA) privileges for the forest root, such as members of the Incoming Forest Trust Builders group. If the old TDO is not automatically removed, an AD Administrator must manually remove it from AD. The IdM server creates a new TDO with an LSA CreateTrustedDomainEx2 call. The TDO credentials are randomly generated using a Samba-provided password generator with 128 random characters. The new TDO is then modified with an LSA SetInformationTrustedDomain call to make sure encryption types supported by the trust are set properly: The RC4_HMAC_MD5 encryption type is enabled, even if there are no RC4 keys in use, due to how Active Directory is designed. AES128_CTS_HMAC_SHA1_96 and AES256_CTS_HMAC_SHA1_96 encryption types are enabled. Note By default, RHEL 9 does not allow SHA-1 encryption, which is an algorithm that AD requires. Make sure you have enabled the AD-SUPPORT system-wide cryptographic subpolicy to allow SHA-1 encryption in your RHEL 9 IdM servers for communication with AD Domain Controllers. See <link TBA>. For a forest trust, verify that in-forest domains can be reached transitively with an LSA SetInformationTrustedDomain call. Add trust topology information about the other forest (IdM in the case of communicating with AD, AD in the case of communicating with IdM) using an LSA RSetForestTrustInformation call. Note This step might cause a conflict for one of three reasons: A SID namespace conflict, reported as an LSA_SID_DISABLED_CONFLICT error. This conflict cannot be resolved. A NetBIOS namespace conflict, reported as an LSA_NB_DISABLED_CONFLICT error. This conflict cannot be resolved. A DNS namespace conflict with a top level name (TLN), reported as an LSA_TLN_DISABLED_CONFLICT error. The IdM server can automatically resolve a TLN conflict if it is caused by another forest. To resolve a TLN conflict, the IdM server performs the following steps: Retrieve forest trust information for the conflicting forest. Add an exclusion entry for the IdM DNS namespace to the AD forest. Set forest trust information for the forest we conflict on. Re-try establishing the trust to the original forest. The IdM server can only resolve these conflicts if you authenticated the ipa trust-add command with the privileges of an AD administrator that can change forest trusts. If you do not have access to those privileges, the administrator of the original forest must manually perform the steps above in the Active Directory Domains and Trusts section of the Windows UI. If it does not exist, create the ID range for the trusted domain. For a forest trust, query Active Directory domain controllers from the forest root for details about the forest topology. The IdM server uses this information to create additional ID ranges for any additional domains from the trusted forest. Additional resources Trust controllers and trust agents Overview Documents (Microsoft) Technical Documents (Microsoft) Privileged Accounts and Groups in Active Directory (Microsoft) 10.2. Checklist of prerequisites for establishing an AD trust You can use the following checklist to review the prerequisites for creating a trust with an AD domain. Table 10.1. Table Component Configuration Additional details Product versions Your Active Directory domain is using a supported version of Windows Server. Supported versions of Windows Server AD Administrator privileges The Active Directory administration account must be a member of one of the following groups: Enterprise Admin (EA) group in the AD forest Domain Admins (DA) group in the forest root domain for your AD forest Networking IPv6 support is enabled in the Linux kernel for all IdM servers. IPv6 requirements in IdM Date and time Verify the date and time settings on both servers match. Time service requirements for IdM Encryption types The following AD accounts have AES encryption keys: AD Administrator AD user accounts AD services If you have recently enabled AES encryption in AD, generate new AES keys with the following steps: Re-establish trust relationships between any AD domains in your forest. Change the passwords for the AD Administrator, user accounts, and services. Support for encryption types in IdM Enabling the AES encryption type in Active Directory using a GPO Firewall You have opened all necessary ports on IdM servers and AD Domain Controllers for bidirectional communication. Ports required for communication between IdM and AD DNS IdM and AD each have unique primary DNS domains. IdM and AD DNS domains do not overlap. Proper DNS service (SRV) records for LDAP and Kerberos services. You can resolve DNS records from all DNS domains in the trust. Kerberos realm names are the upper-case versions of primary DNS domain names. For example, DNS domain example.com has a corresponding Kerberos realm EXAMPLE.COM Configuring DNS and realm settings for a trust Topology Ensure you are attempting to establish a trust with an IdM server you have configured as a trust controller. Trust controllers and trust agents 10.3. Gathering debug logs of an attempt to establish an AD trust If you are experiencing issues with establishing a trust between an IdM environment and AD domain, use the following steps to enable detailed error logging so you can gather logs of an attempt to establish a trust. You can review these logs to help with your troubleshooting efforts, or you can provide them in a Red Hat Technical Support case. Prerequisites You need root permissions to restart IdM services. Procedure To enable debugging for the IdM server, create the file /etc/ipa/server.conf with the following contents. Restart the httpd service to load the debugging configuration. Stop the smb and winbind services. Set the debugging log level for the smb and winbind services. To enable debug logging for Samba client code used by the IdM framework, edit the /usr/share/ipa/smb.conf.empty configuration file to have the following contents. Remove Samba logs. Start the smb and winbind services. Print a timestamp as you attempt to establish a trust with verbose mode enabled. Review the following error log files for information about the failed request: /var/log/httpd/error_log /var/log/samba/log.* Disable debugging. Optional: If you are unable to determine the cause of the authentication issue: Collect and archive the log files you recently generated. Open a Red Hat Technical Support case and provide the timestamp and debug logs from the attempt. Additional resources IPA - AD Trust Troubleshooting
[ "[global] debug=True", "systemctl restart httpd", "systemctl stop smb winbind", "net conf setparm global 'log level' 100", "[global] log level = 100", "rm /var/log/samba/log.*", "systemctl start smb winbind", "date; ipa -vvv trust-add --type=ad ad.example.com", "mv /etc/ipa/server.conf /etc/ipa/server.conf.backup systemctl restart httpd systemctl stop smb winbind net conf setparm global 'log level' 0 mv /usr/share/ipa/smb.conf.empty /usr/share/ipa/smb.conf.empty.backup systemctl start smb winbind", "tar -cvf debugging-trust.tar /var/log/httpd/error_log /var/log/samba/log.*" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/installing_trust_between_idm_and_ad/assembly_troubleshooting-setting-up-a-cross-forest-trust_installing-trust-between-idm-and-ad
probe::tcp.recvmsg.return
probe::tcp.recvmsg.return Name probe::tcp.recvmsg.return - Receiving TCP message complete Synopsis tcp.recvmsg.return Values saddr A string representing the source IP address dport TCP destination port daddr A string representing the destination IP address size Number of bytes received or error code if an error occurred. sport TCP source port family IP address family name Name of this probe Context The process which receives a tcp message
null
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/systemtap_tapset_reference/api-tcp-recvmsg-return
20.16.12. Graphical framebuffers
20.16.12. Graphical framebuffers A graphics device allows for graphical interaction with the guest virtual machine OS. A guest virtual machine will typically have either a framebuffer or a text console configured to allow interaction with the admin. To specify the graphical framebuffer devices configuration settings, use a management tool to make the following changes to the domain XML: ... <devices> <graphics type='sdl' display=':0.0'/> <graphics type='vnc' port='5904'> <listen type='address' address='192.0.2.1'/> </graphics> <graphics type='rdp' autoport='yes' multiUser='yes' /> <graphics type='desktop' fullscreen='yes'/> <graphics type='spice'> <listen type='network' network='rednet'/> </graphics> </devices> ... Figure 20.56. Graphical Framebuffers The graphics element has a mandatory type attribute which takes the value sdl , vnc , rdp or desktop as explained below: Table 20.20. Graphical framebuffer elements Parameter Description sdl This displays a window on the host physical machine desktop, it can take 3 optional arguments: a display attribute for the display to use, an xauth attribute for the authentication identifier, and an optional fullscreen attribute accepting values yes or no vnc Starts a VNC server. The port attribute specifies the TCP port number (with -1 as legacy syntax indicating that it should be auto-allocated). The autoport attribute is the new preferred syntax for indicating autoallocation of the TCP port to use. The listen attribute is an IP address for the server to listen on. The passwd attribute provides a VNC password in clear text. The keymap attribute specifies the keymap to use. It is possible to set a limit on the validity of the password be giving an timestamp passwdValidTo='2010-04-09T15:51:00' assumed to be in UTC. The connected attribute allows control of connected client during password changes. VNC accepts keep value only and note that it may not be supported by all hypervisors. Rather than using listen/port, QEMU supports a socket attribute for listening on a unix domain socket path. spice Starts a SPICE server. The port attribute specifies the TCP port number (with -1 as legacy syntax indicating that it should be auto-allocated), while tlsPort gives an alternative secure port number. The autoport attribute is the new preferred syntax for indicating auto-allocation of both port numbers. The listen attribute is an IP address for the server to listen on. The passwd attribute provides a SPICE password in clear text. The keymap attribute specifies the keymap to use. It is possible to set a limit on the validity of the password be giving an timestamp passwdValidTo='2010-04-09T15:51:00' assumed to be in UTC. The connected attribute allows control of connected client during password changes. SPICE accepts keep to keep client connected, disconnect to disconnect client and fail to fail changing password. Note it is not be supported by all hypervisors. The defaultMode attribute sets the default channel security policy, valid values are secure , insecure and the default any (which is secure if possible, but falls back to insecure rather than erroring out if no secure path is available). When SPICE has both a normal and TLS secured TCP port configured, it may be desirable to restrict what channels can be run on each port. This is achieved by adding one or more channel elements inside the main graphics element. Valid channel names include main , display , inputs , cursor , playback , record ; smartcard ; and usbredir . To specify the SPICE configuration settings, use a mangement tool to make the following changes to the domain XML: <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> <image compression='auto_glz'/> <streaming mode='filter'/> <clipboard copypaste='no'/> <mouse mode='client'/> </graphics> Figure 20.57. SPICE configuration SPICE supports variable compression settings for audio, images and streaming. These settings are accessible by using the compression attribute in all following elements: image to set image compression (accepts auto_glz, auto_lz, quick, glz, lz, off), jpeg for JPEG compression for images over wan (accepts auto, never, always), zlib for configuring wan image compression (accepts auto, never, always) and playback for enabling audio stream compression (accepts on or off). Streaming mode is set by the streaming element, settings its mode attribute to one of filter , all or off . In addition, Copy and paste functionality (using the SPICE agent) is set by the clipboard element. It is enabled by default, and can be disabled by setting the copypaste property to no . Mouse mode is set by the mouse element, setting its mode attribute to one of server or client . If no mode is specified, the qemu default will be used ( client mode). Additional elements include: Table 20.21. Additional graphical framebuffer elements Parameter Description rdp Starts a RDP server. The port attribute specifies the TCP port number (with -1 as legacy syntax indicating that it should be auto-allocated). The autoport attribute is the new preferred syntax for indicating autoallocation of the TCP port to use. The replaceUser attribute is a boolean deciding whether multiple simultaneous connections to the VM are permitted. The multiUser whether the existing connection must be dropped and a new connection must be established by the VRDP server, when a new client connects in single connection mode. desktop This value is reserved for VirtualBox domains for the moment. It displays a window on the host physical machine desktop, similarly to "sdl", but uses the VirtualBox viewer. Just like "sdl", it accepts the optional attributes display and fullscreen. listen Rather than putting the address information used to set up the listening socket for graphics types vnc and spice in the graphics , the listen attribute, a separate subelement of graphics , called listen can be specified (see the examples above). listen accepts the following attributes: type - Set to either address or network. This tells whether this listen element is specifying the address to be used directly, or by naming a network (which will then be used to determine an appropriate address for listening). address - this attribute will contain either an IP address or host name (which will be resolved to an IP address via a DNS query) to listen on. In the "live" XML of a running domain, this attribute will be set to the IP address used for listening, even if type='network' . network - if type='network' , the network attribute will contain the name of a network in libvirt's list of configured networks. The named network configuration will be examined to determine an appropriate listen address. For example, if the network has an IPv4 address in its configuration (for instance if it has a forward type of route, nat, or no forward type (isolated)), the first IPv4 address listed in the network's configuration will be used. If the network is describing a host physical machine bridge, the first IPv4 address associated with that bridge device will be used, and if the network is describing one of the 'direct' (macvtap) modes, the first IPv4 address of the first forward dev will be used.
[ "<devices> <graphics type='sdl' display=':0.0'/> <graphics type='vnc' port='5904'> <listen type='address' address='192.0.2.1'/> </graphics> <graphics type='rdp' autoport='yes' multiUser='yes' /> <graphics type='desktop' fullscreen='yes'/> <graphics type='spice'> <listen type='network' network='rednet'/> </graphics> </devices>", "<graphics type='spice' port='-1' tlsPort='-1' autoport='yes'> <channel name='main' mode='secure'/> <channel name='record' mode='insecure'/> <image compression='auto_glz'/> <streaming mode='filter'/> <clipboard copypaste='no'/> <mouse mode='client'/> </graphics>" ]
https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/6/html/virtualization_administration_guide/sub-section-libvirt-dom-xml-devices-graphical-framebuffers