Class: Ansible::Ruby::Modules::Cs_securitygroup_rule

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb

Overview

Add and remove security group rules.

Instance Method Summary

• #cidr ⇒ String^?

  CIDR (full notation) to be used for security group rule.

• #end_port ⇒ Integer^?

  End port for this rule.

• #icmp_code ⇒ Integer^?

  Error code for this icmp message.

• #icmp_type ⇒ Integer^?

  Type of the icmp message being sent.

• #poll_async ⇒ Boolean^?

  Poll async jobs until job has finished.

• #project ⇒ Object^?

  Name of the project the security group to be created in.

• #protocol ⇒ :tcp, ...

  Protocol of the security group rule.

• #security_group ⇒ String

  Name of the security group the rule is related to.

• #start_port ⇒ Integer^?

  Start port for this rule.

• #state ⇒ :present, ...

  State of the security group rule.

• #type ⇒ :ingress, ...

  Ingress or egress security group rule.

• #user_security_group ⇒ String^?

  Security group this rule is based of.

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

#cidr ⇒ String^?

Returns CIDR (full notation) to be used for security group rule.

Returns:

• (String, nil) —

  CIDR (full notation) to be used for security group rule.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 28

attribute :cidr

#end_port ⇒ Integer^?

Returns End port for this rule. Required if C(protocol=tcp) or C(protocol=udp), but C(start_port) will be used if not set.

Returns:

• (Integer, nil) —

  End port for this rule. Required if C(protocol=tcp) or C(protocol=udp), but C(start_port) will be used if not set.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 40

attribute :end_port

#icmp_code ⇒ Integer^?

Returns Error code for this icmp message. Required if C(protocol=icmp).

Returns:

• (Integer, nil) —

  Error code for this icmp message. Required if C(protocol=icmp).

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 48

attribute :icmp_code

#icmp_type ⇒ Integer^?

Returns Type of the icmp message being sent. Required if C(protocol=icmp).

Returns:

• (Integer, nil) —

  Type of the icmp message being sent. Required if C(protocol=icmp).

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 44

attribute :icmp_type

#poll_async ⇒ Boolean^?

Returns Poll async jobs until job has finished.

Returns:

• (Boolean, nil) —

  Poll async jobs until job has finished.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 55

attribute :poll_async

#project ⇒ Object^?

Returns Name of the project the security group to be created in.

Returns:

• (Object, nil) —

  Name of the project the security group to be created in.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 52

attribute :project

#protocol ⇒ :tcp, ...

Returns Protocol of the security group rule.

Returns:

• (:tcp, :udp, :icmp, :ah, :esp, :gre, nil) —

  Protocol of the security group rule.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 20

attribute :protocol

#security_group ⇒ String

Returns Name of the security group the rule is related to. The security group must be existing.

Returns:

• (String) —

  Name of the security group the rule is related to. The security group must be existing.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 12

attribute :security_group

#start_port ⇒ Integer^?

Returns Start port for this rule. Required if C(protocol=tcp) or C(protocol=udp).

Returns:

• (Integer, nil) —

  Start port for this rule. Required if C(protocol=tcp) or C(protocol=udp).

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 36

attribute :start_port

#state ⇒ :present, ...

Returns State of the security group rule.

Returns:

• (:present, :absent, nil) —

  State of the security group rule.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 16

attribute :state

#type ⇒ :ingress, ...

Returns Ingress or egress security group rule.

Returns:

• (:ingress, :egress, nil) —

  Ingress or egress security group rule.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 24

attribute :type

#user_security_group ⇒ String^?

Returns Security group this rule is based of.

Returns:

• (String, nil) —

  Security group this rule is based of.

# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_securitygroup_rule.rb', line 32

attribute :user_security_group