Class: Ansible::Ruby::Modules::Bigip_smtp

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

Overview

Allows configuring of the BIG-IP to send mail via an SMTP server by configuring the parameters of an SMTP server.

Instance Method Summary collapse

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

#authentication ⇒ Symbol?

Returns Credentials can be set on an SMTP server’s configuration even if that authentication is not used (think staging configs or emergency changes). This parameter acts as a switch to make the specified C(smtp_server_username) and C(smtp_server_password) parameters active or not.,When C(yes), the authentication parameters will be active.,When C(no), the authentication parameters will be inactive.

Returns:

  • (Symbol, nil) —

    Credentials can be set on an SMTP server’s configuration even if that authentication is not used (think staging configs or emergency changes). This parameter acts as a switch to make the specified C(smtp_server_username) and C(smtp_server_password) parameters active or not.,When C(yes), the authentication parameters will be active.,When C(no), the authentication parameters will be inactive.



39
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 39

attribute :authentication

#encryption ⇒ :none, ...

Returns Specifies whether the SMTP server requires an encrypted connection in order to send mail.

Returns:

  • (:none, :ssl, :tls, nil) —

    Specifies whether the SMTP server requires an encrypted connection in order to send mail.



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 35

attribute :encryption

#from_address ⇒ String?

Returns Email address that the email is being sent from. This is the “Reply-to” address that the recipient sees.

Returns:

  • (String, nil) —

    Email address that the email is being sent from. This is the “Reply-to” address that the recipient sees.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 31

attribute :from_address

#local_host_name ⇒ String?

Returns Host name used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the BIG-IP system’s hostname.

Returns:

  • (String, nil) —

    Host name used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the BIG-IP system’s hostname.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 27

attribute :local_host_name

#name ⇒ String

Returns Specifies the name of the SMTP server configuration.

Returns:

  • (String) —

    Specifies the name of the SMTP server configuration.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 12

attribute :name

#partition ⇒ String?

Returns Device partition to manage resources on.

Returns:

  • (String, nil) —

    Device partition to manage resources on.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 16

attribute :partition

#smtp_server ⇒ String?

Returns SMTP server host name in the format of a fully qualified domain name.,This value is required when create a new SMTP configuration.

Returns:

  • (String, nil) —

    SMTP server host name in the format of a fully qualified domain name.,This value is required when create a new SMTP configuration.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 20

attribute :smtp_server

#smtp_server_password ⇒ String?

Returns Password that the SMTP server requires when validating a user.

Returns:

  • (String, nil) —

    Password that the SMTP server requires when validating a user.



47
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 47

attribute :smtp_server_password

#smtp_server_port ⇒ Object?

Returns Specifies the SMTP port number.,When creating a new SMTP configuration, the default is C(25) when C(encryption) is C(none) or C(tls). The default is C(465) when C(ssl) is selected.

Returns:

  • (Object, nil) —

    Specifies the SMTP port number.,When creating a new SMTP configuration, the default is C(25) when C(encryption) is C(none) or C(tls). The default is C(465) when C(ssl) is selected.



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 24

attribute :smtp_server_port

#smtp_server_username ⇒ String?

Returns User name that the SMTP server requires when validating a user.

Returns:

  • (String, nil) —

    User name that the SMTP server requires when validating a user.



43
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 43

attribute :smtp_server_username

#state ⇒ :present, ...

Returns When C(present), ensures that the SMTP configuration exists.,When C(absent), ensures that the SMTP configuration does not exist.

Returns:

  • (:present, :absent, nil) —

    When C(present), ensures that the SMTP configuration exists.,When C(absent), ensures that the SMTP configuration does not exist.



51
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 51

attribute :state

#update_password ⇒ :always, ...

Returns Passwords are stored encrypted, so the module cannot know if the supplied C(smtp_server_password) is the same or different than the existing password. This parameter controls the updating of the C(smtp_server_password) credential.,When C(always), will always update the password.,When C(on_create), will only set the password for newly created SMTP server configurations.

Returns:

  • (:always, :on_create, nil) —

    Passwords are stored encrypted, so the module cannot know if the supplied C(smtp_server_password) is the same or different than the existing password. This parameter controls the updating of the C(smtp_server_password) credential.,When C(always), will always update the password.,When C(on_create), will only set the password for newly created SMTP server configurations.



55
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_smtp.rb', line 55

attribute :update_password