Class: Ansible::Ruby::Modules::Oc

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb

Overview

This module allows management of resources in an OpenShift cluster. The inventory host can be any host with network connectivity to the OpenShift cluster; the default port being 8443/TCP. This module relies on a token to authenticate to OpenShift. This can either be a user or a service account.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#host ⇒ String?

Returns Hostname or address of the OpenShift API endpoint. By default, this is expected to be the current inventory host.

Returns:

  • (String, nil) —

    Hostname or address of the OpenShift API endpoint. By default, this is expected to be the current inventory host.



13
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 13

attribute :host

#inline ⇒ Hash?

Returns The inline definition of the resource. This is mutually exclusive with name, namespace and kind.

Returns:

  • (Hash, nil) —

    The inline definition of the resource. This is mutually exclusive with name, namespace and kind.



21
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 21

attribute :inline

#kind ⇒ String

Returns The kind of the resource upon which to take action.

Returns:

  • (String) —

    The kind of the resource upon which to take action.



25
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 25

attribute :kind

#name ⇒ String?

Returns The name of the resource on which to take action.

Returns:

  • (String, nil) —

    The name of the resource on which to take action.



29
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 29

attribute :name

#namespace ⇒ String?

Returns The namespace of the resource upon which to take action.

Returns:

  • (String, nil) —

    The namespace of the resource upon which to take action.



33
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 33

attribute :namespace

#port ⇒ Integer?

Returns The port number of the API endpoint.

Returns:

  • (Integer, nil) —

    The port number of the API endpoint.



17
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 17

attribute :port

#state ⇒ :present, :absent

Returns If the state is present, and the resource doesn’t exist, it shall be created using the inline definition. If the state is present and the resource exists, the definition will be updated, again using an inline definition. If the state is absent, the resource will be deleted if it exists.

Returns:

  • (:present, :absent) —

    If the state is present, and the resource doesn’t exist, it shall be created using the inline definition. If the state is present and the resource exists, the definition will be updated, again using an inline definition. If the state is absent, the resource will be deleted if it exists.



45
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 45

attribute :state

#token ⇒ String

Returns The token with which to authenticate against the OpenShift cluster.

Returns:

  • (String) —

    The token with which to authenticate against the OpenShift cluster.



37
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 37

attribute :token

#validate_certs ⇒ Boolean?

Returns If C(no), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (Boolean, nil) —

    If C(no), SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.



41
 
# File 'lib/ansible/ruby/modules/generated/clustering/openshift/oc.rb', line 41

attribute :validate_certs