Class: Ansible::Ruby::Modules::Azure_rm_networkinterface

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb

Overview

Create, update or delete a network interface. When creating a network interface you must provide the name of an existing virtual network, the name of an existing subnet within the virtual network. A default security group and public IP address will be created automatically, or you can provide the name of an existing security group and public IP address. See the examples below for more details.

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

#create_with_security_group ⇒ Boolean?

Returns Specifies whether a default security group should be be created with the NIC. Only applies when creating a new NIC.

Returns:

  • (Boolean, nil) —

    Specifies whether a default security group should be be created with the NIC. Only applies when creating a new NIC.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 65

attribute :create_with_security_group

#dns_servers ⇒ Array<String>, ...

Returns Which DNS servers should the NIC lookup,List of IP’s.

Returns:

  • (Array<String>, String, nil) —

    Which DNS servers should the NIC lookup,List of IP’s



80
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 80

attribute :dns_servers

#enable_accelerated_networking ⇒ Symbol?

Returns Specifies whether the network interface should be created with the accelerated networking feature or not.

Returns:

  • (Symbol, nil) —

    Specifies whether the network interface should be created with the accelerated networking feature or not



61
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 61

attribute :enable_accelerated_networking

#enable_ip_forwarding ⇒ Symbol?

Returns Whether to enable IP forwarding.

Returns:

  • (Symbol, nil) —

    Whether to enable IP forwarding



76
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 76

attribute :enable_ip_forwarding

#ip_configurations ⇒ Array<Hash>, ...

Returns List of ip configuration if contains mutilple configuration, should contain configuration object include field private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, public_ip_allocation_method, name.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of ip configuration if contains mutilple configuration, should contain configuration object include field private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, public_ip_allocation_method, name



57
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 57

attribute :ip_configurations

#location ⇒ Object?

Returns Valid azure location. Defaults to location of the resource group.

Returns:

  • (Object, nil) —

    Valid azure location. Defaults to location of the resource group.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 24

attribute :location

#name ⇒ String

Returns Name of the network interface.

Returns:

  • (String) —

    Name of the network interface.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 16

attribute :name

#open_ports ⇒ Object?

Returns When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.

Returns:

  • (Object, nil) —

    When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.



73
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 73

attribute :open_ports

#os_type ⇒ :Windows, ...

Returns Determines any rules to be added to a default security group. When creating a network interface, if no security group name is provided, a default security group will be created. If the os_type is ‘Windows’, a rule will be added allowing RDP access. If the os_type is ‘Linux’, a rule allowing SSH access will be added.

Returns:

  • (:Windows, :Linux, nil) —

    Determines any rules to be added to a default security group. When creating a network interface, if no security group name is provided, a default security group will be created. If the os_type is ‘Windows’, a rule will be added allowing RDP access. If the os_type is ‘Linux’, a rule allowing SSH access will be added.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 35

attribute :os_type

#private_ip_address ⇒ Object?

Returns (Deprecate) Valid IPv4 address that falls within the specified subnet.,This option will be deprecated in 2.9, use I(ip_configurations) instead.

Returns:

  • (Object, nil) —

    (Deprecate) Valid IPv4 address that falls within the specified subnet.,This option will be deprecated in 2.9, use I(ip_configurations) instead.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 39

attribute :private_ip_address

#private_ip_allocation_method ⇒ :Dynamic, ...

Returns (Deprecate) Specify whether or not the assigned IP address is permanent. NOTE: when creating a network interface specifying a value of ‘Static’ requires that a private_ip_address value be provided. You can update the allocation method to ‘Static’ after a dynamic private ip address has been assigned.,This option will be deprecated in 2.9, use I(ip_configurations) instead.

Returns:

  • (:Dynamic, :Static, nil) —

    (Deprecate) Specify whether or not the assigned IP address is permanent. NOTE: when creating a network interface specifying a value of ‘Static’ requires that a private_ip_address value be provided. You can update the allocation method to ‘Static’ after a dynamic private ip address has been assigned.,This option will be deprecated in 2.9, use I(ip_configurations) instead.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 42

attribute :private_ip_allocation_method

#public_ip ⇒ :yes, ...

Returns (Deprecate) When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created.,This option will be deprecated in 2.9, use I(ip_configurations) instead.

Returns:

  • (:yes, :no, nil) —

    (Deprecate) When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created.,This option will be deprecated in 2.9, use I(ip_configurations) instead.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 46

attribute :public_ip

#public_ip_address_name ⇒ Object?

Returns (Deprecate) Name of an existing public IP address object to associate with the security group.,This option will be deprecated in 2.9, use I(ip_configurations) instead.

Returns:

  • (Object, nil) —

    (Deprecate) Name of an existing public IP address object to associate with the security group.,This option will be deprecated in 2.9, use I(ip_configurations) instead.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 50

attribute :public_ip_address_name

#public_ip_allocation_method ⇒ :Dynamic, ...

Returns (Deprecate) If a public_ip_address_name is not provided, a default public IP address will be created. The allocation method determines whether or not the public IP address assigned to the network interface is permanent.,This option will be deprecated in 2.9, use I(ip_configurations) instead.

Returns:

  • (:Dynamic, :Static, nil) —

    (Deprecate) If a public_ip_address_name is not provided, a default public IP address will be created. The allocation method determines whether or not the public IP address assigned to the network interface is permanent.,This option will be deprecated in 2.9, use I(ip_configurations) instead.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 53

attribute :public_ip_allocation_method

#resource_group ⇒ String

Returns Name of a resource group where the network interface exists or will be created.

Returns:

  • (String) —

    Name of a resource group where the network interface exists or will be created.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 12

attribute :resource_group

#security_group ⇒ String, ...

Returns An existing security group with which to associate the network interface. If not provided, a default security group will be created when C(create_with_security_group) is true.,It can be the name of security group.,Make sure the security group is in the same resource group when you only give its name.,It can be the resource id.,It can be a dict contains security_group’s C(name) and C(resource_group).

Returns:

  • (String, Hash, nil) —

    An existing security group with which to associate the network interface. If not provided, a default security group will be created when C(create_with_security_group) is true.,It can be the name of security group.,Make sure the security group is in the same resource group when you only give its name.,It can be the resource id.,It can be a dict contains security_group’s C(name) and C(resource_group).



69
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 69

attribute :security_group

#state ⇒ :absent, ...

Returns Assert the state of the network interface. Use ‘present’ to create or update an interface and ‘absent’ to delete an interface.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the network interface. Use ‘present’ to create or update an interface and ‘absent’ to delete an interface.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 20

attribute :state

#subnet_name ⇒ String

Returns Name of an existing subnet within the specified virtual network. Required when creating a network interface,Use the C(virtual_network)‘s resource group.

Returns:

  • (String) —

    Name of an existing subnet within the specified virtual network. Required when creating a network interface,Use the C(virtual_network)‘s resource group.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 31

attribute :subnet_name

#virtual_network ⇒ String

Returns An existing virtual network with which the network interface will be associated. Required when creating a network interface.,It can be the virtual network’s name.,Make sure your virtual network is in the same resource group as NIC when you give only the name.,It can be the virtual network’s resource id.,It can be a dict which contains C(name) and C(resource_group) of the virtual network.

Returns:

  • (String) —

    An existing virtual network with which the network interface will be associated. Required when creating a network interface.,It can be the virtual network’s name.,Make sure your virtual network is in the same resource group as NIC when you give only the name.,It can be the virtual network’s resource id.,It can be a dict which contains C(name) and C(resource_group) of the virtual network.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/azure/azure_rm_networkinterface.rb', line 27

attribute :virtual_network