[[start#objects|<< zurück]]

==== ipnet object ====

^ Method  ^ URL                               ^ Notes                                                  ^
| GET     | /rest/{IF}/ipnet                  | returns a list of all IP networks                      |
| GET     | /rest/{IF}/ipnet/{id}             | information of the IP network                          |
| GET     | /rest/{IF}/ipnet/{id}/ipaddr      | returns a list of all IP addresses in this IP network  |
| GET     | /rest/{IF}/ipnet/{id}/dhcpoption  | returns a list of the dhcp options of this network     |
| GET     | /rest/{IF}/ipnet/{id}/dhcprange   | returns a list of the dhcp ranges of this network      |

== available parameters ==

^ Parameter  ^ Type    ^ Method            ^ Notes                                               ^
| id         | int     | GET, PUT, DELETE  | unique identifier of the object                     |
| name       | string  | POST,PUT          | network's name or readable identifier               |
| net        | IP      | POST              | network address                                     |
| bits       | int     | POST              | number of bits (CIDR), related to the network size  |
| notes      | text    | POST, PUT         | Description of the network                          |
| vrf_id     | int     | POST, PUT         | id of the related VRF                               |
| realm_id   | int     | POST, PUT         | id of the related realm                             |
| tenant_id  | int     | POST, PUT         | id of the related tenant                            |

[[start#objects|<< zurück]]