Class: Ansible::Ruby::Modules::Dnsimple

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb

Overview

Manages domains and records via the DNSimple API, see the docs: U(developer.dnsimple.com/)

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

#account_api_token ⇒ String?

Returns Account API token. See I(account_email) for info.

Returns:

  • (String, nil) —

    Account API token. See I(account_email) for info.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 15

attribute :account_api_token

#account_email ⇒ String?

Returns Account email. If omitted, the env variables DNSIMPLE_EMAIL and DNSIMPLE_API_TOKEN will be looked for. If those aren’t found, a C(.dnsimple) file will be looked for, see: U(github.com/mikemaccana/dnsimple-python#getting-started).

Returns:



11
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 11

attribute :account_email

#domain ⇒ String?

Returns Domain to work with. Can be the domain name (e.g. “mydomain.com”) or the numeric ID of the domain in DNSimple. If omitted, a list of domains will be returned.,If domain is present but the domain doesn’t exist, it will be created.

Returns:

  • (String, nil) —

    Domain to work with. Can be the domain name (e.g. “mydomain.com”) or the numeric ID of the domain in DNSimple. If omitted, a list of domains will be returned.,If domain is present but the domain doesn’t exist, it will be created.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 19

attribute :domain

#priority ⇒ Object?

Returns Record priority.

Returns:

  • (Object, nil) —

    Record priority



43
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 43

attribute :priority

#record ⇒ String?

Returns Record to add, if blank a record for the domain will be created, supports the wildcard (*).

Returns:

  • (String, nil) —

    Record to add, if blank a record for the domain will be created, supports the wildcard (*)



23
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 23

attribute :record

#record_ids ⇒ String?

Returns List of records to ensure they either exist or don’t exist.

Returns:

  • (String, nil) —

    List of records to ensure they either exist or don’t exist



27
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 27

attribute :record_ids

#solo ⇒ Object?

Returns Whether the record should be the only one for that record type and record name. Only use with state=present on a record.

Returns:

  • (Object, nil) —

    Whether the record should be the only one for that record type and record name. Only use with state=present on a record



50
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 50

attribute :solo

#state ⇒ :present, ...

Returns whether the record should exist or not.

Returns:

  • (:present, :absent, nil) —

    whether the record should exist or not



46
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 46

attribute :state

#ttl ⇒ String?

Returns The TTL to give the new record.

Returns:

  • (String, nil) —

    The TTL to give the new record



35
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 35

attribute :ttl

#type ⇒ :A, ...

Returns The type of DNS record to create.

Returns:

  • (:A, :ALIAS, :CNAME, :MX, :SPF, :URL, :TXT, :NS, :SRV, :NAPTR, :PTR, :AAAA, :SSHFP, :HINFO, :POOL, nil) —

    The type of DNS record to create



31
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 31

attribute :type

#value ⇒ String?

Returns Record value,Must be specified when trying to ensure a record exists.

Returns:

  • (String, nil) —

    Record value,Must be specified when trying to ensure a record exists



39
 
# File 'lib/ansible/ruby/modules/generated/extras/network/dnsimple.rb', line 39

attribute :value