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 collapse
-
#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
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. You can obtain your API key from the bottom of the Cloudflare ‘My Account’ page, found here: U(dash.cloudflare.com/)rn.
12 |
# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 12 attribute :account_api_token |
#account_email ⇒ String
Returns Account email.
16 |
# 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).
20 |
# 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).
24 |
# 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).
28 |
# 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).
32 |
# 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).
36 |
# 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).
40 |
# 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.
44 |
# 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.
48 |
# 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).
52 |
# 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).
56 |
# 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).
60 |
# 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.
64 |
# 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.
68 |
# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 68 attribute :state |
#timeout ⇒ Integer?
Returns Timeout for Cloudflare API calls.
72 |
# 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.
76 |
# 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.
80 |
# 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).
84 |
# 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).
88 |
# 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.
92 |
# File 'lib/ansible/ruby/modules/generated/net_tools/cloudflare_dns.rb', line 92 attribute :zone |