.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::dhcp 3pm"
.TH VM::EC2::REST::dhcp 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::dhcp \- Manage DHCP Option objects"
.IX Header "NAME VM::EC2::REST::dhcp - Manage DHCP Option objects"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 qw(:vpn);
.Ve
.SH "METHODS"
.IX Header "METHODS"
These methods manage \s-1DHCP\s0 Option objects, which can then be applied to
a \s-1VPC\s0 to configure the \s-1DHCP\s0 options applied to running instances. You
get these methods when you import the tag \*(L":vpn\*(R".
.PP
Implemented:
 AssociateDhcpOptions
 CreateDhcpOptions
 DeleteDhcpOptions
 DescribeDhcpOptions
.PP
Unimplemented;
 (none)
.ie n .SS "$options = $ec2\->create_dhcp_options(\e%configuration_list)"
.el .SS "\f(CW$options\fP = \f(CW$ec2\fP\->create_dhcp_options(\e%configuration_list)"
.IX Subsection "$options = $ec2->create_dhcp_options(%configuration_list)"
This method creates a DhcpOption object, The single required argument is a
configuration list hash (which can be passed either as a hashref or a
flattened hash) with one or more of the following keys:
.PP
.Vb 1
\& \-domain_name            Domain name for instances running in this VPC.
\&
\& \-domain_name_servers    Scalar or arrayref containing up to 4 IP addresses of
\&                         domain name servers for this VPC.
\&
\& \-ntp_servers            Scalar or arrayref containing up to 4 IP addresses
\&                         of network time protocol servers
\&
\& \-netbios_name_servers   Scalar or arrayref containing up to 4 IP addresses for
\&                         NetBIOS name servers.
\&
\& \-netbios_node_type      The NetBios node type (1,2,4 or 8). Amazon recommends
\&                         using "2" at this time.
.Ve
.PP
On successful completion, a VM::EC2::VPC::DhcpOptions object will be
returned. This can be associated with a \s-1VPC\s0 using the \s-1VPC\s0 object's
\&\fIset_dhcp_options()\fR method:
.PP
.Vb 4
\& $vpc     = $ec2\->create_vpc(...);
\& $options = $ec2\->create_dhcp_options(\-domain_name=>\*(Aqtest.com\*(Aq,
\&                                      \-domain_name_servers=>[\*(Aq204.16.255.55\*(Aq,\*(Aq216.239.34.10\*(Aq]);
\& $vpc\->set_dhcp_options($options);
.Ve
.ie n .SS "$success = $ec2\->delete_dhcp_options($dhcp_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_dhcp_options($dhcp_id)"
.IX Subsection "$success = $ec2->delete_dhcp_options($dhcp_id)"
Delete the indicated DHCPOptions, returning true if successful. You
may also use the named argument \-dhcp_options_id..
.ie n .SS "@options = $ec2\->describe_dhcp_options(@option_ids)"
.el .SS "\f(CW@options\fP = \f(CW$ec2\fP\->describe_dhcp_options(@option_ids)"
.IX Subsection "@options = $ec2->describe_dhcp_options(@option_ids)"
.ie n .SS "@options = $ec2\->describe_dhcp_options(\e%filters)"
.el .SS "\f(CW@options\fP = \f(CW$ec2\fP\->describe_dhcp_options(\e%filters)"
.IX Subsection "@options = $ec2->describe_dhcp_options(%filters)"
.ie n .SS "@options = $ec2\->describe_dhcp_options(\-dhcp_options_id=>$id, \-filter         => \e%filters)"
.el .SS "\f(CW@options\fP = \f(CW$ec2\fP\->describe_dhcp_options(\-dhcp_options_id=>$id, \-filter         => \e%filters)"
.IX Subsection "@options = $ec2->describe_dhcp_options(-dhcp_options_id=>$id, -filter => %filters)"
This method returns a list of VM::EC2::VPC::DhcpOptions objects, which
describe a set of \s-1DHCP\s0 options that can be assigned to a \s-1VPC.\s0 Called
with no arguments, it returns all DhcpOptions. Pass a list of option
IDs or a filter hashref in order to restrict the search.
.PP
Optional arguments:
.PP
.Vb 2
\& \-dhcp_options_id     Scalar or arrayref of DhcpOption IDs.
\& \-filter              Hashref of filters.
.Ve
.PP
Available filters are described at
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeDhcpOptions.html.
.ie n .SS "$success = $ec2\->associate_dhcp_options($vpc_id => $dhcp_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->associate_dhcp_options($vpc_id => \f(CW$dhcp_id\fP)"
.IX Subsection "$success = $ec2->associate_dhcp_options($vpc_id => $dhcp_id)"
.ie n .SS "$success = $ec2\->associate_dhcp_options(\-vpc_id => $vpc_id,\-dhcp_options_id => $dhcp_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->associate_dhcp_options(\-vpc_id => \f(CW$vpc_id\fP,\-dhcp_options_id => \f(CW$dhcp_id\fP)"
.IX Subsection "$success = $ec2->associate_dhcp_options(-vpc_id => $vpc_id,-dhcp_options_id => $dhcp_id)"
Associate a \s-1VPC ID\s0 with a \s-1DHCP\s0 option set. Pass an \s-1ID\s0 of 'default' to
restore the default \s-1DHCP\s0 options for the \s-1VPC.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.