netbox/docs/models/ipam/service.md

33 lines
1.4 KiB
Markdown
Raw Normal View History

2020-03-05 11:20:10 -05:00
# Services
2022-08-16 15:32:00 -04:00
A service represents a layer seven application available on a device or virtual machine. For example, a service might be created in NetBox to represent an HTTP server running on TCP/8000. Each service may optionally be further bound to one or more specific interfaces assigned to the selected device or virtual machine.
2020-03-05 11:20:10 -05:00
2022-08-16 15:32:00 -04:00
To aid in the efficient creation of services, users may opt to first create a [service template](./servicetemplate.md) from which service definitions can be quickly replicated.
## Fields
### Parent
The parent object to which the service is assigned. This must be one of [Device](../dcim/device.md),
[VirtualMachine](../virtualization/virtualmachine.md), or [FHRP Group](./fhrpgroup.md).
!!! note "Changed in NetBox v4.3"
Previously, `parent` was a property that pointed to either a Device or Virtual Machine. With the capability to assign services to FHRP groups, this is a unified in a concrete field.
2022-08-16 15:32:00 -04:00
### Name
A service or protocol name.
### Protocol
The wire protocol on which the service runs. Choices include UDP, TCP, and SCTP.
### Ports
One or more numeric ports to which the service is bound. Multiple ports can be expressed using commas and/or hyphens. For example, `80,8001-8003` specifies ports 80, 8001, 8002, and 8003.
### IP Addresses
The [IP address(es)](./ipaddress.md) to which this service is bound. If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.