Class: Ansible::Ruby::Modules::Netcup_dns

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb

Overview

Manages DNS records via the Netcup API, see the docs U(ccp.netcup.net/run/webservice/servers/endpoint.php)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#api_key ⇒ String

Returns API key for authentification, must be obtained via the netcup CCP (U(ccp.netcup.net)).

Returns:

  • (String) —

    API key for authentification, must be obtained via the netcup CCP (U(ccp.netcup.net))



12
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 12

attribute :api_key

#api_password ⇒ String

Returns API password for authentification, must be obtained via the netcup CCP (ccp.netcup.net).

Returns:

  • (String) —

    API password for authentification, must be obtained via the netcup CCP (ccp.netcup.net)



16
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 16

attribute :api_password

#customer_id ⇒ String

Returns Netcup customer id.

Returns:

  • (String) —

    Netcup customer id



20
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 20

attribute :customer_id

#domain ⇒ String

Returns Domainname the records should be added / removed.

Returns:

  • (String) —

    Domainname the records should be added / removed



24
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 24

attribute :domain

#priority ⇒ Object?

Returns Record priority. Required for C(type=MX).

Returns:

  • (Object, nil) —

    Record priority. Required for C(type=MX)



44
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 44

attribute :priority

#record ⇒ String?

Returns Record to add or delete, supports wildcard (*). Default is C(@) (e.g. the zone name).

Returns:

  • (String, nil) —

    Record to add or delete, supports wildcard (*). Default is C(@) (e.g. the zone name)



28
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 28

attribute :record

#solo ⇒ Symbol?

Returns Whether the record should be the only one for that record type and record name. Only use with C(state=present),This will delete all other records with the same record name and type.

Returns:

  • (Symbol, nil) —

    Whether the record should be the only one for that record type and record name. Only use with C(state=present),This will delete all other records with the same record name and type.



40
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 40

attribute :solo

#state ⇒ :present, ...

Returns Whether the record should exist or not.

Returns:

  • (:present, :absent, nil) —

    Whether the record should exist or not



47
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 47

attribute :state

#type ⇒ :A, ...

Returns Record type.

Returns:

  • (:A, :AAAA, :MX, :CNAME, :CAA, :SRV, :TXT, :TLSA, :NS, :DS) —

    Record type



32
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 32

attribute :type

#value ⇒ String

Returns Record value.

Returns:

  • (String) —

    Record value



36
 
# File 'lib/ansible/ruby/modules/generated/net_tools/netcup_dns.rb', line 36

attribute :value