| Parameter | Choices/Defaults | Comments | 
                
                                                            | api_key 
                    string
                                                                 |  | Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. | 
                            
                                                            | api_version 
                    string
                                                                 | Default: 
 "v1" | Use to specify the API version. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with kind, name, and namespace to identify a specific object. If resource definition is provided, the apiVersion from the resource_definition will override this option. aliases: api, version
 | 
                            
                                                            | append_hash 
                    boolean
                                                                 added in 2.8 |  | Whether to append a hash to a resource name for immutability purposes Applies only to ConfigMap and Secret resources The parameter will be silently ignored for other resource kinds The full definition of an object is needed to generate the hash - this means that deleting an object created with append_hash will only work if the same object is passed with state=absent (alternatively, just use state=absent with the name including the generated hash and append_hash=no) Requires openshift >= 0.7.2 | 
                            
                                                            | apply 
                    boolean
                                                                 added in 2.9 |  | applycompares the desired resource definition with the previously supplied resource definition, ignoring properties that are automatically generated
 applyworks better with Services than 'force=yes'
 Requires openshift >= 0.9.2 mutually exclusive with merge_type | 
                            
                                                            | ca_cert 
                    path
                                                                 |  | Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. aliases: ssl_ca_cert
 | 
                            
                                                            | client_cert 
                    path
                                                                 |  | Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. aliases: cert_file
 | 
                            
                                                            | client_key 
                    path
                                                                 |  | Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. aliases: key_file
 | 
                            
                                                            | context 
                    string
                                                                 |  | The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. | 
                            
                                                            | force 
                    boolean
                                                                 |  | If set to yes, and state ispresent, an existing object will be replaced. | 
                            
                                                            | host 
                    string
                                                                 |  | Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. | 
                            
                                                            | kind 
                    string
                                                                 |  | Use to specify an object model. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, name, and namespace to identify a specific object. If resource definition is provided, the kind from the resource_definition will override this option. | 
                            
                                                            | kubeconfig 
                    path
                                                                 |  | Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable. | 
                            
                                                            | merge_type 
                    list
                                                                 added in 2.7 | Choices:
                                                                                                                                                            jsonmergestrategic-merge | Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used. For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may want to use mergeif you see "strategic merge patch format is not supported" Requires openshift >= 0.6.2 If more than one merge_type is given, the merge_types will be tried in order If openshift >= 0.6.2, this defaults to ['strategic-merge', 'merge'], which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources. For openshift < 0.6.2, the default is simplystrategic-merge. mutually exclusive with apply | 
                            
                                                            | name 
                    string
                                                                 |  | Use to specify an object name. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, kind and namespace to identify a specific object. If resource definition is provided, the metadata.name value from the resource_definition will override this option. | 
                            
                                                            | namespace 
                    string
                                                                 |  | Use to specify an object namespace. Useful when creating, deleting, or discovering an object without providing a full resource definition. Use in conjunction with api_version, kind, and name to identify a specfic object. If resource definition is provided, the metadata.namespace value from the resource_definition will override this option. | 
                            
                                                            | password 
                    string
                                                                 |  | Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. Please read the description of the usernameoption for a discussion of when this option is applicable. | 
                            
                                                            | proxy 
                    -
                                                                 added in 2.9 |  | The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable. Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY). | 
                            
                                                            | resource_definition 
                    -
                                                                 |  | Provide a valid YAML definition (either as a string, list, or dict) for an object when creating or updating. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the provided resource_definition. aliases: definition, inline
 | 
                            
                                                            | src 
                    path
                                                                 |  | Provide a path to a file containing a valid YAML definition of an object or objects to be created or updated. Mutually exclusive with resource_definition. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the configuration read in from the src file. Reads from the local file system. To read from the Ansible controller's file system, including vaulted files, use the file lookup plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to resource_definition. See Examples below. | 
                            
                                                            | state 
                    string
                                                                 | Choices:
                                                                                                                                                            absentpresent ← | Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set toabsent, an existing object will be deleted. If set topresent, an existing object will be patched, if its attributes differ from those specified using resource_definition or src. | 
                            
                                                            | username 
                    string
                                                                 |  | Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the k8s_authmodule, as that might do what you need. | 
                            
                                                            | validate 
                    -
                                                                 added in 2.8 |  | how (if at all) to validate the resource definition against the kubernetes schema. Requires the kubernetes-validate python module and openshift >= 0.8.0 | 
                                                        
                                                |  | fail_on_error 
                    boolean
                                             / required                     |  | whether to fail on validation errors. | 
                            
                                                |  | strict 
                    boolean
                                                                 |  | whether to fail when passing unexpected properties | 
                            
                                                |  | version 
                    -
                                                                 |  | version of Kubernetes to validate against. defaults to Kubernetes server version | 
                                            
                                                            | validate_certs 
                    boolean
                                                                 |  | Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. aliases: verify_ssl
 | 
                            
                                                            | wait 
                    boolean
                                                                 added in 2.8 |  | Whether to wait for certain resource kinds to end up in the desired state. By default the module exits once Kubernetes has received the request Implemented for state=presentforDeployment,DaemonSetandPod, and forstate=absentfor all resource kinds. For resource kinds without an implementation, waitreturns immediately unlesswait_conditionis set. | 
                            
                                                            | wait_condition 
                    -
                                                                 added in 2.8 |  | Specifies a custom condition on the status to wait for. Ignored if waitis not set or is set to False. | 
                                                        
                                                |  | reason 
                    -
                                                                 |  | The value of the reason field in your desired condition For example, if a Deploymentis paused, TheProgressingc(type) will have theDeploymentPausedreason. The possible reasons in a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices. | 
                            
                                                |  | status 
                    -
                                                                 |  | The value of the status field in your desired condition. For example, if a Deploymentis paused, theProgressingtypewill have theUnknownstatus. | 
                            
                                                |  | type 
                    -
                                                                 |  | The type of condition to wait for. For example, the Podresource will set theReadycondition (among others) Required if you are specifying a wait_condition. If left empty, thewait_conditionfield will be ignored. The possible types for a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices. | 
                                            
                                                            | wait_sleep 
                    -
                                                                 added in 2.9 | Default: 
 5 | Number of seconds to sleep between checks. | 
                            
                                                            | wait_timeout 
                    -
                                                                 added in 2.8 | Default: 
 120 | How long in seconds to wait for the resource to end up in the desired state. Ignored if waitis not set. |