GNU.WIKI: The GNU/Linux Knowledge Base

  [HOME] [PHP Manual] [HowTo] [ABS] [MAN1] [MAN2] [MAN3] [MAN4] [MAN5] [MAN6] [MAN7] [MAN8] [MAN9]

  [0-9] [Aa] [Bb] [Cc] [Dd] [Ee] [Ff] [Gg] [Hh] [Ii] [Jj] [Kk] [Ll] [Mm] [Nn] [Oo] [Pp] [Qq] [Rr] [Ss] [Tt] [Uu] [Vv] [Ww] [Xx] [Yy] [Zz]


NAME VM::EC2::REST::vpn_gateway - Create and manage Virtual Private Network

       Gateways

SYNOPSIS

        use VM::EC2 ':vpc';

METHODS

       These methods create and manage Virtual Private Network Gateways (VGW).

       Implemented:
        AttachVpnGateway
        CreateVpnGateway
        DeleteVpnGateway
        DescribeVpnGateways
        DisableVgwRoutePropagation
        EnableVgwRoutePropagation

       Unimplemented:
        (none)

   @gtwys = $ec2->describe_vpn_gateways(-vpn_gateway_id=>\@ids, -filter
       =>\%filters)
   @gtwys = $ec2->describe_vpn_gateways(@vpn_gateway_ids)
   @gtwys = $ec2->describe_vpn_gateways(%filters)
       Provides information on VPN gateways.

       Return a series of VM::EC2::VPC::VpnGateway objects.  When called with
       no arguments, returns all VPN gateways.  Pass a list of VPN gateway IDs
       or use the assorted filters to restrict the search.

       Optional parameters are:

        -vpn_gateway_id         ID of the gateway(s) to return information on.
                                This can be a string scalar, or an arrayref.

        -filter                 Tags and other filters to apply.

       The filter argument is a hashreference in which the keys are the filter
       names, and the values are the match strings. Some filters accept
       wildcards.

       There are a number of filters, which are listed in full at
       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVpnGateways.php

       Here is a alpha-sorted list of filter names: attachment.state,
       attachment.vpc-id, availability-zone, state, tag-key, tag-value,
       tag:key, type, vpn-gateway-id

   $vpn_gateway = $ec2->create_vpn_gateway(-type=>$type)
   $vpn_gateway = $ec2->create_vpn_gateway($type)
   $vpn_gateway = $ec2->create_vpn_gateway
       Creates a new virtual private gateway. A virtual private gateway is the
       VPC-side endpoint for a VPN connection. You can create a virtual
       private gateway before creating the VPC itself.

        -type switch is optional as there is only one type as of API 2012-06-15

       Returns a VM::EC2::VPC::VpnGateway object on success

   $success = $ec2->delete_vpn_gateway(-vpn_gateway_id=>$id);
   $success = $ec2->delete_vpn_gateway($id);
       Deletes a virtual private gateway.  Use this when a VPC and all its
       associated components are no longer needed.  It is recommended that
       before deleting a virtual private gateway, detach it from the VPC and
       delete the VPN connection.  Note that it is not necessary to delete the
       virtual private gateway if the VPN connection between the VPC and data
       center needs to be recreated.

       Arguments:

        -vpn_gateway_id    -- The ID of the VPN gateway to delete.

       Returns true on successful deletion

   $state = $ec2->attach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id
       =>$vpc_id)
       Attaches a virtual private gateway to a VPC.

       Arguments:

        -vpc_id          -- The ID of the VPC to attach the VPN gateway to

        -vpn_gateway_id  -- The ID of the VPN gateway to attach

       Returns the state of the attachment, one of:
          attaching | attached | detaching | detached

   $success = $ec2->detach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id
       =>$vpc_id)
       Detaches a virtual private gateway from a VPC. You do this if you're
       planning to turn off the VPC and not use it anymore. You can confirm a
       virtual private gateway has been completely detached from a VPC by
       describing the virtual private gateway (any attachments to the virtual
       private gateway are also described).

       You must wait for the attachment's state to switch to detached before
       you can delete the VPC or attach a different VPC to the virtual private
       gateway.

       Arguments:

        -vpc_id          -- The ID of the VPC to detach the VPN gateway from

        -vpn_gateway_id  -- The ID of the VPN gateway to detach

       Returns true on successful detachment.

   $success = $ec2->enable_vgw_route_propagation(-route_table_id=>$rt_id,
       -gateway_id    =>$gtwy_id)
       Enables a virtual private gateway (VGW) to propagate routes to the
       routing tables of an Amazon VPC.

       Arguments:

        -route_table_id        -- The ID of the routing table.

        -gateway_id            -- The ID of the virtual private gateway.

       Returns true on successful enablement.

   $success = $ec2->disable_vgw_route_propagation(-route_table_id=>$rt_id,
       -gateway_id    =>$gtwy_id)
       Disables a virtual private gateway (VGW) from propagating routes to the
       routing tables of an Amazon VPC.

       Arguments:

        -route_table_id        -- The ID of the routing table.

        -gateway_id            -- The ID of the virtual private gateway.

       Returns true on successful disablement.

SEE ALSO

       VM::EC2

AUTHOR

       Lincoln Stein <lincoln.stein@gmail.com>.

       Copyright (c) 2011 Ontario Institute for Cancer Research

       This package and its accompanying libraries is free software; you can
       redistribute it and/or modify it under the terms of the GPL (either
       version 1, or at your option, any later version) or the Artistic
       License 2.0.  Refer to LICENSE for the full license text. In addition,
       please see DISCLAIMER.txt for disclaimers of warranty.



  All copyrights belong to their respective owners. Other content (c) 2014-2018, GNU.WIKI. Please report site errors to webmaster@gnu.wiki.
Page load time: 0.115 seconds. Last modified: November 04 2018 12:49:43.