Class: Ansible::Ruby::Modules::Cloudflare_dns

Inherits:

Base

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

Defined in:

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

Overview

Manages dns records via the Cloudflare API, see the docs: U(api.cloudflare.com/)

Instance Method Summary

• #account_api_token ⇒ String

  Account API token.

• #account_email ⇒ String

  Account email.

• #algorithm ⇒ Integer^?

  Algorithm number.

• #cert_usage ⇒ 0, ...

  Certificate usage number.

• #hash_type ⇒ 1, ...

  Hash type number.

• #key_tag ⇒ Integer^?

  DNSSEC key tag.

• #port ⇒ Integer^?

  Service port.

• #priority ⇒ String^?

  Record priority.

• #proto ⇒ String^?

  Service protocol.

• #proxied ⇒ :yes, ...

  Proxy through cloudflare network or just use DNS.

• #record ⇒ String^?

  Record to add.

• #selector ⇒ 0, ...

  Selector number.

• #service ⇒ String^?

  Record service.

• #solo ⇒ Boolean^?

  Whether the record should be the only one for that record type and record name.

• #state ⇒ :present, ...

  Whether the record(s) should exist or not.

• #timeout ⇒ Integer^?

  Timeout for Cloudflare API calls.

• #ttl ⇒ String^?

  The TTL to give the new record.

• #type ⇒ :A, ...

  The type of DNS record to create.

• #value ⇒ String^?

  The record value.

• #weight ⇒ String^?

  Service weight.

• #zone ⇒ String

  The name of the Zone to work with (e.g. “example.com”).

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

#account_api_token ⇒ String

Returns Account API token. You can obtain your API key from the bottom of the Cloudflare ‘My Account’ page, found here: U(dash.cloudflare.com/)rn.

Returns:

• (String) —

  Account API token. You can obtain your API key from the bottom of the Cloudflare ‘My Account’ page, found here: U(dash.cloudflare.com/)rn

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

attribute :account_api_token

#account_email ⇒ String

Returns Account email.

Returns:

• (String) —

  Account email.

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

attribute :account_email

#algorithm ⇒ Integer^?

Returns Algorithm number. Required for C(type=DS) and C(type=SSHFP) when C(state=present).

Returns:

• (Integer, nil) —

  Algorithm number. Required for C(type=DS) and C(type=SSHFP) when C(state=present).

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

attribute :algorithm

#cert_usage ⇒ 0, ...

Returns Certificate usage number. Required for C(type=TLSA) when C(state=present).

Returns:

• (0, 1, 2, 3, nil) —

  Certificate usage number. Required for C(type=TLSA) when C(state=present).

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

attribute :cert_usage

#hash_type ⇒ 1, ...

Returns Hash type number. Required for C(type=DS), C(type=SSHFP) and C(type=TLSA) when C(state=present).

Returns:

• (1, 2, nil) —

  Hash type number. Required for C(type=DS), C(type=SSHFP) and C(type=TLSA) when C(state=present).

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

attribute :hash_type

#key_tag ⇒ Integer^?

Returns DNSSEC key tag. Needed for C(type=DS) when C(state=present).

Returns:

• (Integer, nil) —

  DNSSEC key tag. Needed for C(type=DS) when C(state=present).

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

attribute :key_tag

#port ⇒ Integer^?

Returns Service port. Required for C(type=SRV) and C(type=TLSA).

Returns:

• (Integer, nil) —

  Service port. Required for C(type=SRV) and C(type=TLSA).

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

attribute :port

#priority ⇒ String^?

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

Returns:

• (String, nil) —

  Record priority. Required for C(type=MX) and C(type=SRV)

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

attribute :priority

#proto ⇒ String^?

Returns Service protocol. Required for C(type=SRV) and C(type=TLSA).,Common values are tcp and udp.,Before Ansible 2.6 only tcp and udp were available.

Returns:

• (String, nil) —

  Service protocol. Required for C(type=SRV) and C(type=TLSA).,Common values are tcp and udp.,Before Ansible 2.6 only tcp and udp were available.

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

attribute :proto

#proxied ⇒ :yes, ...

Returns Proxy through cloudflare network or just use DNS.

Returns:

• (:yes, :no, nil) —

  Proxy through cloudflare network or just use DNS

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 48

attribute :proxied

#record ⇒ String^?

Returns Record to add. Required if C(state=present). Default is C(@) (e.g. the zone name).

Returns:

• (String, nil) —

  Record to add. Required if C(state=present). Default is C(@) (e.g. the zone name)

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 52

attribute :record

#selector ⇒ 0, ...

Returns Selector number. Required for C(type=TLSA) when C(state=present).

Returns:

• (0, 1, nil) —

  Selector number. Required for C(type=TLSA) when C(state=present).

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 56

attribute :selector

#service ⇒ String^?

Returns Record service. Required for C(type=SRV).

Returns:

• (String, nil) —

  Record service. Required for C(type=SRV)

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 60

attribute :service

#solo ⇒ Boolean^?

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:

• (Boolean, 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.

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 64

attribute :solo

#state ⇒ :present, ...

Returns Whether the record(s) should exist or not.

Returns:

• (:present, :absent, nil) —

  Whether the record(s) should exist or not

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 68

attribute :state

#timeout ⇒ Integer^?

Returns Timeout for Cloudflare API calls.

Returns:

• (Integer, nil) —

  Timeout for Cloudflare API calls

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 72

attribute :timeout

#ttl ⇒ String^?

Returns The TTL to give the new record. Must be between 120 and 2,147,483,647 seconds, or 1 for automatic.

Returns:

• (String, nil) —

  The TTL to give the new record. Must be between 120 and 2,147,483,647 seconds, or 1 for automatic.

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 76

attribute :ttl

#type ⇒ :A, ...

Returns The type of DNS record to create. Required if C(state=present),C(type=DS), C(type=SSHFP) and C(type=TLSA) added in Ansible 2.7.

Returns:

• (:A, :AAAA, :CNAME, :TXT, :SRV, :MX, :NS, :DS, :SPF, :SSHFP, :TLSA, nil) —

  The type of DNS record to create. Required if C(state=present),C(type=DS), C(type=SSHFP) and C(type=TLSA) added in Ansible 2.7.

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 80

attribute :type

#value ⇒ String^?

Returns The record value. Required for C(state=present).

Returns:

• (String, nil) —

  The record value. Required for C(state=present)

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 84

attribute :value

#weight ⇒ String^?

Returns Service weight. Required for C(type=SRV).

Returns:

• (String, nil) —

  Service weight. Required for C(type=SRV)

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 88

attribute :weight

#zone ⇒ String

Returns The name of the Zone to work with (e.g. “example.com”). The Zone must already exist.

Returns:

• (String) —

  The name of the Zone to work with (e.g. “example.com”). The Zone must already exist.

# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 92

attribute :zone