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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Dnsimple

Defined in:

lib/ansible/ruby/modules/generated/net_tools/dnsimple.rb

Overview

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

Instance Method Summary

• #account_api_token ⇒ String^?

  Account API token.

• #account_email ⇒ String^?

  Account email.

• #domain ⇒ String^?

  Domain to work with.

• #priority ⇒ Object^?

  Record priority.

• #record ⇒ String^?

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

• #record_ids ⇒ String^?

  List of records to ensure they either exist or do not exist.

• #solo ⇒ Symbol^?

  Whether the record should be the only one for that record type and record name.,Only use with C(state) is set to C(present) on a record.

• #state ⇒ :present, ...

  Whether the record should exist or not.

• #ttl ⇒ Integer^?

  The TTL to give the new record in seconds.

• #type ⇒ :A, ...

  The type of DNS record to create.

• #value ⇒ String^?

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

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 more information.

Returns:

• (String, nil) —

  Account API token. See I(account_email) for more information.

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

attribute :account_api_token

#account_email ⇒ String^?

Returns Account email. If omitted, the environment variables C(DNSIMPLE_EMAIL) and C(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:

• (String, nil) —

  Account email. If omitted, the environment variables C(DNSIMPLE_EMAIL) and C(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).

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

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.

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

attribute :domain

#priority ⇒ Object^?

Returns Record priority.

Returns:

• (Object, nil) —

  Record priority.

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

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 (*).

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

attribute :record

#record_ids ⇒ String^?

Returns List of records to ensure they either exist or do not exist.

Returns:

• (String, nil) —

  List of records to ensure they either exist or do not exist.

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

attribute :record_ids

#solo ⇒ Symbol^?

Returns Whether the record should be the only one for that record type and record name.,Only use with C(state) is set to C(present) on a record.

Returns:

• (Symbol, nil) —

  Whether the record should be the only one for that record type and record name.,Only use with C(state) is set to C(present) on a record.

# File 'lib/ansible/ruby/modules/generated/net_tools/dnsimple.rb', line 51

attribute :solo

#state ⇒ :present, ...

Returns whether the record should exist or not.

Returns:

• (:present, :absent, nil) —

  whether the record should exist or not.

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

attribute :state

#ttl ⇒ Integer^?

Returns The TTL to give the new record in seconds.

Returns:

• (Integer, nil) —

  The TTL to give the new record in seconds.

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

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.

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

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.

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

attribute :value