Class: Fog::Network::OpenStack::Real

Constants

UPDATE_OPTIONS	=	[ :name, :shared, :admin_state_up, :qos_policy_id, :port_security_enabled	Not all options can be updated
UPDATE_EXTENTED_OPTIONS	=	[ :router_external	Not all extra options can be updated
CREATE_OPTIONS	=	[ :name, :shared, :admin_state_up, :qos_policy_id, :port_security_enabled, :tenant_id, ].freeze
EXTENTED_OPTIONS	=	[ :provider_network_type, :provider_segmentation_id, :provider_physical_network, :router_external, ].freeze	Advanced Features through API Extensions Not strictly required but commonly found in OpenStack installs with Quantum networking. @see docs.openstack.org/trunk/openstack-network/admin/content/provider_attributes.html
ALIASES	=	{ :provider_network_type => 'provider:network_type', # Not applicable to the "local" or "gre" network types :provider_physical_network => 'provider:physical_network', :provider_segmentation_id => 'provider:segmentation_id', :router_external => 'router:external'	Map Fog::Network::OpenStack::Network model attributes to OpenStack provider attributes

Public Class methods

create(options)

new(options = {})

not_found_class()

update(options)

Public Instance methods

add_router_interface(router_id, subnet_id_or_options)

associate_floating_ip(floating_ip_id, port_id, options = {})

associate_lb_health_monitor(pool_id, health_monitor_id)

create_floating_ip(floating_network_id, options = {})

create_ike_policy(options = {})

create_ipsec_policy(options = {})

create_ipsec_site_connection(vpn_service_id, ike_policy_id, ipsec_policy_id, options = {})

create_lb_health_monitor(type, delay, timeout, max_retries, options = {})

create_lb_member(pool_id, address, protocol_port, weight, options = {})

create_lb_pool(subnet_id, protocol, lb_method, options = {})

create_lb_vip(subnet_id, pool_id, protocol, protocol_port, options = {})

create_lbaas_healthmonitor(pool_id, type, delay, timeout, max_retries, options = {})

create_lbaas_l7policy(listener_id, action, options = {})

create_lbaas_l7rule(l7policy_id, type, compare_type, value, options = {})

create_lbaas_listener(loadbalancer_id, protocol, protocol_port, options = {})

create_lbaas_loadbalancer(vip_subnet_id, options = {})

create_lbaas_pool(listener_id, protocol, lb_algorithm, options = {})

create_lbaas_pool_member(pool_id, address, protocol_port, options = {})

create_network(options = {})

create_port(network_id, options = {})

create_rbac_policy(options = {})

create_router(name, options = {})

create_security_group(options = {})

Create a new security group

Parameters

options<~Hash>:
- ‘name’<~String> - Name of the security group
- ‘description’<~String> - Description of the security group
- ‘tenant_id’<~String> - TenantId different than the current user, that should own the security group. Only allowed if user has ‘admin’ role.

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_groups’<~Array>:
  - ‘id’<~String> - UUID of the security group
  - ‘name’<~String> - Name of the security group
  - ‘description’<~String> - Description of the security group
  - ‘tenant_id’<~String> - Tenant id that owns the security group
  - ‘security_group_rules’<~Array>: - Array of security group rules
    - ‘id’<~String> - UUID of the security group rule
    - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
    - ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
    - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
    - ‘security_group_id’<~String> - UUID of the parent security group
    - ‘remote_group_id’<~String> - UUID of the remote security group
    - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
    - ‘tenant_id’<~String> - Tenant id that owns the security group rule

create_security_group_rule(security_group_id, direction, options = {})

Create a new security group rule

Parameters

‘security_group_id’<~String> - UUID of the parent security group
‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
options<~Hash>:
- ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
- ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
- ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
- ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
- ‘remote_group_id’<~String> - UUID of the remote security group
- ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
- ‘tenant_id’<~String> - TenantId different than the current user, that should own the security group. Only allowed if user has ‘admin’ role.

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_group_rule’<~Hash>:
  - ‘id’<~String> - UUID of the security group rule
  - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
  - ‘port_range_min’<~String> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘port_range_max’<~String> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
  - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
  - ‘security_group_id’<~String> - UUID of the parent security group
  - ‘remote_group_id’<~String> - UUID of the source security group
  - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
  - ‘tenant_id’<~String> - Tenant id that owns the security group rule

create_subnet(network_id, cidr, ip_version, options = {})

create_subnet_pool(name, prefixes, options = {})

create_vpn_service(subnet_id, router_id, options = {})

delete_floating_ip(floating_ip_id)

delete_ike_policy(ike_policy_id)

delete_ipsec_policy(ipsec_policy_id)

delete_ipsec_site_connection(ipsec_site_connection_id)

delete_lb_health_monitor(health_monitor_id)

delete_lb_member(member_id)

delete_lb_pool(pool_id)

delete_lb_vip(vip_id)

delete_lbaas_healthmonitor(healthmonitor_id)

delete_lbaas_l7policy(l7policy_id)

delete_lbaas_l7rule(l7policy_id, l7rule_id)

delete_lbaas_listener(listener_id)

delete_lbaas_loadbalancer(loadbalancer_id)

delete_lbaas_pool(pool_id)

delete_lbaas_pool_member(pool_id, member_id)

delete_network(network_id)

delete_port(port_id)

delete_quota(tenant_id)

delete_rbac_policy(rbac_policy_id)

delete_router(router_id)

delete_security_group(security_group_id)

Delete a security group

Parameters

‘security_group_id’<~String> - UUID of the security group to delete

delete_security_group_rule(security_group_rule_id)

Delete a security group rule

Parameters

‘security_group_rule_id’<~String> - UUID of the security group rule to delete

delete_subnet(subnet_id)

delete_subnet_pool(subnet_pool_id)

delete_vpn_service(vpn_service_id)

disassociate_floating_ip(floating_ip_id, options = {})

disassociate_lb_health_monitor(pool_id, health_monitor_id)

get_extension(name)

get_floating_ip(floating_ip_id)

get_ike_policy(ike_policy_id)

get_ipsec_policy(ipsec_policy_id)

get_ipsec_site_connection(ipsec_site_connection_id)

get_lb_health_monitor(health_monitor_id)

get_lb_member(member_id)

get_lb_pool(pool_id)

get_lb_pool_stats(pool_id)

get_lb_vip(vip_id)

get_lbaas_healthmonitor(healthmonitor_id)

get_lbaas_l7policy(l7policy_id)

get_lbaas_l7rule(l7policy_id, l7rule_id)

get_lbaas_listener(listener_id)

get_lbaas_loadbalancer(loadbalancer_id)

get_lbaas_pool(pool_id)

get_lbaas_pool_member(pool_id, member_id)

get_network(network_id)

get_network_ip_availability(network_id)

get_port(port_id)

get_quota(tenant_id)

get_quotas()

get_rbac_policy(rbac_policy_id)

get_router(router_id)

get_security_group(security_group_id)

Get details about a security group

Parameters

‘security_group_id’<~String> - UUID of the security group

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_group’<~Array>:
  - ‘id’<~String> - UUID of the security group
  - ‘name’<~String> - Name of the security group
  - ‘description’<~String> - Description of the security group
  - ‘tenant_id’<~String> - Tenant id that owns the security group
  - ‘security_group_rules’<~Array>: - Array of security group rules
    - ‘id’<~String> - UUID of the security group rule
    - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
    - ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
    - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
    - ‘security_group_id’<~String> - UUID of the parent security group
    - ‘remote_group_id’<~String> - UUID of the remote security group
    - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
    - ‘tenant_id’<~String> - Tenant id that owns the security group rule

get_security_group_rule(security_group_rule_id)

Get details about a security group rule

Parameters

‘security_group_rule_id’<~String> - UUID of the security group rule

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_group_rule’<~Hash>:
  - ‘id’<~String> - UUID of the security group rule
  - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
  - ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
  - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
  - ‘security_group_id’<~String> - UUID of the parent security group
  - ‘remote_group_id’<~String> - UUID of the remote security group
  - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
  - ‘tenant_id’<~String> - Tenant id that owns the security group rule

get_subnet(subnet_id)

get_subnet_pool(subnet_pool_id)

get_vpn_service(vpn_service_id)

list_extensions(filters = {})

list_floating_ips(filters = {})

list_ike_policies(filters = {})

list_ipsec_policies(filters = {})

list_ipsec_site_connections(filters = {})

list_lb_health_monitors(filters = {})

list_lb_members(filters = {})

list_lb_pools(filters = {})

list_lb_vips(filters = {})

list_lbaas_healthmonitors(filters = {})

list_lbaas_l7policies(filters = {})

list_lbaas_l7rules(l7policy_id, filters = {})

list_lbaas_listeners(filters = {})

list_lbaas_loadbalancers(filters = {})

list_lbaas_pool_members(pool_id, filters = {})

list_lbaas_pools(filters = {})

list_network_ip_availabilities()

list_networks(filters = {})

list_ports(filters = {})

list_rbac_policies(filters = {})

list_routers(filters = {})

list_security_group_rules(options = {})

List all security group rules

Parameters

options<~Hash>:

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_group_rules’<~Array>:
  - ‘id’<~String> - UUID of the security group rule
  - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
  - ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
  - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
  - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
  - ‘security_group_id’<~String> - UUID of the parent security group
  - ‘remote_group_id’<~String> - UUID of the remote security group
  - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
  - ‘tenant_id’<~String> - Tenant id that owns the security group rule

list_security_groups(options = {})

List all security groups

Parameters

options<~Hash>:

Returns

response<~Excon::Response>:
- body<~Hash>:
- ‘security_groups’<~Array>:
  - ‘id’<~String> - UUID of the security group
  - ‘name’<~String> - Name of the security group
  - ‘description’<~String> - Description of the security group
  - ‘tenant_id’<~String> - Tenant id that owns the security group
  - ‘security_group_rules’<~Array>: - Array of security group rules
    - ‘id’<~String> - UUID of the security group rule
    - ‘direction’<~String> - Direction of traffic, must be in [‘ingress’, ‘egress’]
    - ‘port_range_min’<~Integer> - Start port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘port_range_max’<~Integer> - End port for rule i.e. 22 (or -1 for ICMP wildcard)
    - ‘protocol’<~String> - IP protocol for rule, must be in [‘tcp’, ‘udp’, ‘icmp’]
    - ‘ethertype’<~String> - Type of ethernet support, must be in [‘IPv4’, ‘IPv6’]
    - ‘security_group_id’<~String> - UUID of the parent security group
    - ‘remote_group_id’<~String> - UUID of the remote security group
    - ‘remote_ip_prefix’<~String> - IP cidr range address i.e. ‘0.0.0.0/0‘
    - ‘tenant_id’<~String> - Tenant id that owns the security group rule

list_subnet_pools(filters = {})

list_subnets(filters = {})

list_vpn_services(filters = {})

remove_router_interface(router_id, subnet_id, _options = {})

set_api_path()

set_tenant(tenant)

update_ike_policy(ike_policy_id, options = {})

update_ipsec_policy(ipsec_policy_id, options = {})

update_ipsec_site_connection(ipsec_site_connection_id, options = {})

update_lb_health_monitor(health_monitor_id, options = {})

update_lb_member(member_id, options = {})

update_lb_pool(pool_id, options = {})

update_lb_vip(vip_id, options = {})

update_lbaas_healthmonitor(healthmonitor_id, options = {})

update_lbaas_l7policy(l7policy_id, options = {})

update_lbaas_l7rule(l7policy_id, l7rule_id, options = {})

update_lbaas_listener(listener_id, options = {})

update_lbaas_loadbalancer(loadbalancer_id, options = {})

update_lbaas_pool(pool_id, options = {})

update_lbaas_pool_member(pool_id, member_id, options = {})

update_network(network_id, options = {})

update_port(port_id, options = {})

update_quota(tenant_id, options = {})

update_rbac_policy(rbac_policy_id, options = {})

update_router(router_id, options = {})

Update Router

Beyond the name and the administrative state, the only parameter which can be updated with this operation is the external gateway. @see docs.openstack.org/api/openstack-network/2.0/content/router_update.html

update_security_group(security_group_id, options = {})

update_subnet(subnet_id, options = {})

update_subnet_pool(subnet_pool_id, options = {})

update_vpn_service(vpn_service_id, options = {})