VM::EC2::REST::dhcp(3pm)

1VM::EC2::REST::dhcp(3)User Contributed Perl DocumentationVM::EC2::REST::dhcp(3)
2
3
4

NAME VM::EC2::REST::dhcp

SYNOPSIS

7        use VM::EC2 qw(:vpn);
8

METHODS

10       These methods manage DHCP Option objects, which can then be applied to
11       a VPC to configure the DHCP options applied to running instances. You
12       get these methods when you import the tag ":vpn".
13
14       Implemented:
15        AssociateDhcpOptions
16        CreateDhcpOptions
17        DeleteDhcpOptions
18        DescribeDhcpOptions
19
20       Unimplemented;
21        (none)
22
23   $options = $ec2->create_dhcp_options(\%configuration_list)
24       This method creates a DhcpOption object, The single required argument
25       is a configuration list hash (which can be passed either as a hashref
26       or a flattened hash) with one or more of the following keys:
27
28        -domain_name            Domain name for instances running in this VPC.
29
30        -domain_name_servers    Scalar or arrayref containing up to 4 IP addresses of
31                                domain name servers for this VPC.
32
33        -ntp_servers            Scalar or arrayref containing up to 4 IP addresses
34                                of network time protocol servers
35
36        -netbios_name_servers   Scalar or arrayref containing up to 4 IP addresses for
37                                NetBIOS name servers.
38
39        -netbios_node_type      The NetBios node type (1,2,4 or 8). Amazon recommends
40                                using "2" at this time.
41
42       On successful completion, a VM::EC2::VPC::DhcpOptions object will be
43       returned. This can be associated with a VPC using the VPC object's
44       set_dhcp_options() method:
45
46        $vpc     = $ec2->create_vpc(...);
47        $options = $ec2->create_dhcp_options(-domain_name=>'test.com',
48                                             -domain_name_servers=>['204.16.255.55','216.239.34.10']);
49        $vpc->set_dhcp_options($options);
50
51   $success = $ec2->delete_dhcp_options($dhcp_id)
52       Delete the indicated DHCPOptions, returning true if successful. You may
53       also use the named argument -dhcp_options_id..
54
55   @options = $ec2->describe_dhcp_options(@option_ids)
56   @options = $ec2->describe_dhcp_options(\%filters)
57   @options = $ec2->describe_dhcp_options(-dhcp_options_id=>$id, -filter
58       => \%filters)
59       This method returns a list of VM::EC2::VPC::DhcpOptions objects, which
60       describe a set of DHCP options that can be assigned to a VPC. Called
61       with no arguments, it returns all DhcpOptions. Pass a list of option
62       IDs or a filter hashref in order to restrict the search.
63
64       Optional arguments:
65
66        -dhcp_options_id     Scalar or arrayref of DhcpOption IDs.
67        -filter              Hashref of filters.
68
69       Available filters are described at
70       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeDhcpOptions.html.
71
72   $success = $ec2->associate_dhcp_options($vpc_id => $dhcp_id)
73   $success = $ec2->associate_dhcp_options(-vpc_id => $vpc_id,-dhcp_options_id
74       => $dhcp_id)
75       Associate a VPC ID with a DHCP option set. Pass an ID of 'default' to
76       restore the default DHCP options for the VPC.
77

AUTHOR

82       Lincoln Stein <lincoln.stein@gmail.com>.
83
84       Copyright (c) 2011 Ontario Institute for Cancer Research
85
86       This package and its accompanying libraries is free software; you can
87       redistribute it and/or modify it under the terms of the GPL (either
88       version 1, or at your option, any later version) or the Artistic
89       License 2.0.  Refer to LICENSE for the full license text. In addition,
90       please see DISCLAIMER.txt for disclaimers of warranty.
91
92
93
94perl v5.32.1                      2021-01-27            VM::EC2::REST::dhcp(3)

NAME VM::EC2::REST::dhcp

SYNOPSIS

METHODS

SEE ALSO

AUTHOR