Class: Ansible::Ruby::Modules::Ipa_host

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb

Overview

Add, modify and delete an IPA host using IPA API

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

#description ⇒ String?

Returns A description of this host.

Returns:

  • (String, nil) —

    A description of this host.



16
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 16

attribute :description

#force ⇒ Symbol?

Returns Force host name even if not in DNS.

Returns:

  • (Symbol, nil) —

    Force host name even if not in DNS.



20
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 20

attribute :force

#fqdn ⇒ Object

Returns Full qualified domain name.,Can not be changed as it is the unique identifier.

Returns:

  • (Object) —

    Full qualified domain name.,Can not be changed as it is the unique identifier.



12
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 12

attribute :fqdn

#ip_address ⇒ String?

Returns Add the host to DNS with this IP address.

Returns:

  • (String, nil) —

    Add the host to DNS with this IP address.



24
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 24

attribute :ip_address

#mac_address ⇒ Array<String>, ...

Returns List of Hardware MAC address(es) off this host.,If option is omitted MAC addresses will not be checked or changed.,If an empty list is passed all assigned MAC addresses will be removed.,MAC addresses that are already assigned but not passed will be removed.

Returns:

  • (Array<String>, String, nil) —

    List of Hardware MAC address(es) off this host.,If option is omitted MAC addresses will not be checked or changed.,If an empty list is passed all assigned MAC addresses will be removed.,MAC addresses that are already assigned but not passed will be removed.



28
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 28

attribute :mac_address

#ns_hardware_platform ⇒ String?

Returns Host hardware platform (e.g. “Lenovo T61”).

Returns:

  • (String, nil) —

    Host hardware platform (e.g. “Lenovo T61”)



36
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 36

attribute :ns_hardware_platform

#ns_host_location ⇒ String?

Returns Host location (e.g. “Lab 2”).

Returns:

  • (String, nil) —

    Host location (e.g. “Lab 2”)



32
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 32

attribute :ns_host_location

#ns_os_version ⇒ String?

Returns Host operating system and version (e.g. “Fedora 9”).

Returns:

  • (String, nil) —

    Host operating system and version (e.g. “Fedora 9”)



40
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 40

attribute :ns_os_version

#random_password ⇒ Symbol?

Returns Generate a random password to be used in bulk enrollment.

Returns:

  • (Symbol, nil) —

    Generate a random password to be used in bulk enrollment



56
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 56

attribute :random_password

#state ⇒ :present, ...

Returns State to ensure.

Returns:

  • (:present, :absent, :enabled, :disabled, nil) —

    State to ensure



48
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 48

attribute :state

#update_dns ⇒ Symbol?

Returns If set C(“True”) with state as C(“absent”), then removes DNS records of the host managed by FreeIPA DNS.,This option has no effect for states other than “absent”.

Returns:

  • (Symbol, nil) —

    If set C(“True”) with state as C(“absent”), then removes DNS records of the host managed by FreeIPA DNS.,This option has no effect for states other than “absent”.



52
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 52

attribute :update_dns

#user_certificate ⇒ Array<NilClass>, ...

Returns List of Base-64 encoded server certificates.,If option is omitted certificates will not be checked or changed.,If an empty list is passed all assigned certificates will be removed.,Certificates already assigned but not passed will be removed.

Returns:

  • (Array<NilClass>, NilClass, nil) —

    List of Base-64 encoded server certificates.,If option is omitted certificates will not be checked or changed.,If an empty list is passed all assigned certificates will be removed.,Certificates already assigned but not passed will be removed.



44
 
# File 'lib/ansible/ruby/modules/generated/identity/ipa/ipa_host.rb', line 44

attribute :user_certificate