Retrieves the list of OpenShift clusters.
Query parameters
A specific cluster to retrieve.
If non-empty, returned Clusters are filtered to those with matching subscription IDs.
Include hosts in the returned list.
If provided, returns only clusters that are owned by the specified user.
Headers
Whether to return clusters that have been unregistered.
Response
Success.
Indicates the type of this object. Will be 'Cluster' if this is a complete object, 'AddHostsCluster' for cluster that add hosts to existing OCP cluster, 'DisconnectedCluster' for clusters with embedded ignition for offline installation,
(DEPRECATED) Please use 'control_plane_count' instead. Guaranteed availability of the installed cluster. 'Full' installs a Highly-Available cluster over multiple master nodes whereas 'None' installs a full cluster over one node.
Unique identifier of the object.
Self link.
Name of the OpenShift cluster.
Version of the OpenShift cluster.
OpenShift release image URI.
Cluster ID on OCP system.
Base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name.
IP address block from which Pod IPs are allocated. This block must not overlap with existing physical networks. These IP addresses are used for the Pod network, and if you need to access the Pods from an external network, configure load balancers and routers to manage the traffic.
The subnet prefix length to assign to each individual node. For example, if clusterNetworkHostPrefix is set to 23, then each node is assigned a /23 subnet out of the given cidr (clusterNetworkCIDR), which allows for 510 (2^(32 - 23) - 2) pod IPs addresses. If you are required to provide access to nodes from an external network, configure load balancers and routers to manage the traffic.
The IP address pool to use for service IP addresses. You can enter only one IP address pool. If you need to access the services from an external network, configure load balancers and routers to manage the traffic.
The domain name used to reach the OpenShift cluster API.
A CIDR that all hosts belonging to the cluster should have an interfaces with IP address that belongs to this CIDR. The api_vip belongs to this CIDR.
SSH public key for debugging OpenShift nodes.
A proxy URL to use for creating HTTP connections outside the cluster. http://<username>:<pswd>@<ip>:<port>
A proxy URL to use for creating HTTPS connections outside the cluster. http://<username>:<pswd>@<ip>:<port> or https://<username>:<pswd>@<ip>:<port>
A comma-separated list of destination domain names, domains, IP addresses, or other network CIDRs to exclude from proxying.
Status of the OpenShift cluster.
Additional information pertaining to the status of the OpenShift cluster.
The last time that the cluster status was updated.
hosts associated to this cluster that are in 'known' state.
hosts associated to this cluster that are not in 'disabled' state.
All hosts associated to this cluster.
Schedule workloads on masters
Indicates if schedule workloads on masters will be enabled regardless the value of 'schedulable_masters' property. Set to 'true' when not enough hosts are associated with this cluster to disable the scheduling on masters.
The last time that this cluster was updated.
The time that this cluster was created.
The time that this cluster started installation.
The time that this cluster completed installation.
True if the pull secret has been added to the cluster.
Indicate if virtual IP DHCP allocation mode is enabled.
JSON-formatted string containing the validation results for each validation id grouped by category (network, hosts-data, etc.)
JSON-formatted string containing the user overrides for the install-config.yaml file.
Json formatted string containing the majority groups for connectivity checks.
Json formatted string containing ip collisions detected in the cluster.
Json formatted string containing a list of host validations to be ignored. May also contain a list with a single string "all" to ignore all host validations. Some validations cannot be ignored.
Json formatted string containing a list of cluster validations to be ignored. May also contain a list with a single string "all" to ignore all cluster validations. Some validations cannot be ignored.
(DEPRECATED) Indicate if the networking is managed by the user.
A comma-separated list of NTP sources (name or IP) going to be added to all the hosts.
A comma-separated list of NTP sources (name or IP) to be used as the only NTP configuration for the cluster hosts.
Unique identifier of the AMS subscription in OCM.
Enable/disable hyperthreading on master nodes, arbiter nodes, worker nodes, or a combination of them.
JSON-formatted string containing the usage information by feature name
The desired network type used.
- OVNKubernetes: Default CNI for OpenShift (recommended)
- OpenShiftSDN: Legacy SDN (deprecated in newer versions)
- CiscoACI: Cisco ACI CNI (requires custom manifests)
- Cilium: Isovalent Cilium CNI (requires custom manifests)
- Calico: Tigera Calico CNI (requires custom manifests)
- None: No CNI - user must provide custom CNI manifests
The CPU architecture of the image (x86_64/arm64/etc).
Indicates whether this cluster is an imported day-2 cluster or a regular cluster. Clusters are considered imported when they are created via the ../clusters/import endpoint. Day-2 clusters converted from day-1 clusters by kube-api controllers or the ../clusters/<cluster_id>/actions/allow-add-hosts endpoint are not considered imported. Imported clusters usually lack a lot of information and are filled with default values that don't necessarily reflect the actual cluster they represent
A comma-separated list of tags that are associated to the cluster.
Indication if organization soft timeouts is enabled for the cluster.
Specifies the required number of control plane nodes that should be part of the cluster.
Example response
[
{
"disk_encryption": {
"tang_servers": "[{\"url\":\"http://tang.example.com:7500\",\"thumbprint\":\"PLjNyRdGw03zlRoGjQYMahSZGu9\"}, {\"url\":\"http://tang.example.com:7501\",\"thumbprint\":\"PLjNyRdGw03zlRoGjQYMahSZGu8\"}]"
},
"hosts": [
{
"installation_disk_path": "/dev/sda",
"ignition_config_overrides": "{\"ignition\": {\"version\": \"3.1.0\"}, \"storage\": {\"files\": [{\"path\": \"/tmp/example\", \"contents\": {\"source\": \"data:text/plain;base64,aGVscGltdHJhcHBlZGluYXN3YWdnZXJzcGVj\"}}]}}"
}
],
"install_config_overrides": "{\"networking\":{\"networkType\": \"OVNKubernetes\"},\"fips\":true}"
}
]