.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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 "Netdot::Client::REST 3pm"
.TH Netdot::Client::REST 3pm "2022-10-22" "perl v5.36.0" "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"
Netdot::Client::REST \- RESTful API for Netdot
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Netdot::Client::REST;
\& use Data::Dumper;
\&
\& my $netdot = Netdot::Client::REST\->new(
\&     server=>\*(Aqhttp://localhost.localdomain/netdot\*(Aq,
\&     username=>\*(Aqadmin\*(Aq,
\&     password=>\*(Aqxxxxx\*(Aq,
\&     );
\&
\& # Get all devices
\& my @devs = $netdot\->get(\*(Aq/Device\*(Aq);
\&
\& print Dumper(@devs);
\&
\& # Get Device id 1
\& my $dev = $netdot\->get(\*(Aq/Device/1\*(Aq);
\&
\& # Get Device id 1 and foreign objects one level away
\& my $dev = $netdot\->get(\*(Aq/Device/1?depth=1\*(Aq);
\&
\& # Update Device 1
\& $dev = $netdot\->post(\*(Aq/Device/1\*(Aq, {community=>\*(Aqpublic\*(Aq});
\&
\& # Delete Device 1
\& $netdot\->delete(\*(Aq/Device/1\*(Aq);
.Ve
.PP
See examples/ directory for a sample script
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Netdot::Client::REST can be used in Perl scripts that need access to the Netdot application
database. Communication occurs over \s-1HTTP/HTTPS,\s0 thus avoiding the need to open \s-1SQL\s0 access on the machine running Netdot.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS "new \- Constructor and login method"
.IX Subsection "new - Constructor and login method"
.Vb 10
\&  Arguments:
\&    server    \- Netdot installation URL (e.g. http://host.localdomain/netdot)
\&    username  \- Netdot username
\&    password  \- Netdot password
\&    retries   \- Number of retries (default: 3)
\&    timeout   \- seconds (default: 10)
\&    format    \- Representation format (default: xml)
\&                Currently only XML is supported
\&  Returns:
\&    Netdot::Client::REST object
\&  Examples:
\&    my $netdot = Netdot::Client::REST\->new(
\&         server   =>\*(Aqhttp://host.localdomain/netdot\*(Aq,
\&         username => \*(Aqmyuser\*(Aq,
\&         password => \*(Aqmypass\*(Aq,
\&    );
.Ve
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.SS "get \- Get all attributes from one or more Netdot objects"
.IX Subsection "get - Get all attributes from one or more Netdot objects"
.Vb 2
\&  Arguments:
\&    Resource  \- string containing RESTful resource
\&
\&    In addition to the object\*(Aqs class and (optional) ID, the HTTP argument "depth"
\&    allows the user to fetch all foreign objects recursively, limited by the
\&    value of the depth argument.  Foreign objects include relational records 
\&    referenced by the given object and records that reference the given object (both
\&    sides of the one\-to\-many relationship).  The performance impact of the given depth
\&    is a balance between fewer queries with large datasets and more queries with smaller
\&    datasets. The default depth is 0 (only return the given object plus references
\&    to objects directly related).
\&
\&  Returns:
\&    hashref with object\*(Aqs attributes
\&    
\&    A special attribute is added for each foreign key that allows the programmer
\&    to request that resource more easily.  For example, if a record has a field
\&    called \*(Aqfoo\*(Aq which is a foreign key pointing to a record of class \*(AqBar\*(Aq, 
\&    with id \*(Aq1\*(Aq, then the result hashref will include a keys like:
\&
\&       foo => \*(AqFoo bar name\*(Aq,
\&       foo_xlink => \*(AqBar/1\*(Aq,
\&
\&    where \*(Aqfoo_xlink\*(Aq can be passed to this method to get the full Bar/1 resource.
\&
\&  Examples:
\&    my $dev = $netdot\->get(\*(AqDevice/1\*(Aq);
\&    my $dev = $netdot\->get(\*(AqDevice/1?depth=1\*(Aq);
\&    my @alldevs = $netdot\->get(\*(AqDevice\*(Aq);
\&    my @mydevs = $netdot\->get(\*(AqDevice?sysname=mydev\*(Aq);
.Ve
.SS "post \- Update or Insert a Netdot object"
.IX Subsection "post - Update or Insert a Netdot object"
.Vb 8
\&  Arguments:
\&    Resource  \- string containing RESTful resource
\&    data      \- Hashref containing key/value pairs
\&  Returns:
\&    hashref with object\*(Aqs attributes
\&  Examples:
\&    $netdot\->post(\*(AqDevice/1\*(Aq, \e%data);
\&    $netdot\->post(\*(AqDevice\*(Aq, \e%data);
.Ve
.SS "delete \- Delete a Netdot object"
.IX Subsection "delete - Delete a Netdot object"
.Vb 6
\&  Arguments:
\&    Resource  \- string containing RESTful resource
\&  Returns:
\&    True if successful
\&  Examples:
\&    $netdot\->delete(\*(AqDevice/1\*(Aq);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Carlos Vicente  <cvicente@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
The Network Documentation Tool <http://netdot.uoregon.edu>
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2012, Carlos Vicente <cvicente@cpan.org>. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE \*(L"AS IS\*(R" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.\s0
.PP
\&\s-1IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE\s0 (\s-1INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0