blob: 612d26e2edc9bd89e154a1f5373776f7cfc5705e [file] [log] [blame]
Jamie Hannafordb0d99122014-09-25 10:49:14 +02001// Package networkattrs gives access to the provider Neutron plugin, allowing
2// network extended attributes. The provider extended attributes for networks
3// enable administrative users to specify how network objects map to the
4// underlying networking infrastructure. These extended attributes also appear
5// when administrative users query networks.
6//
7// For more information about extended attributes, see the NetworkExtAttrs
8// struct. The actual semantics of these attributes depend on the technology
9// back end of the particular plug-in. See the plug-in documentation and the
10// OpenStack Cloud Administrator Guide to understand which values should be
11// specific for each of these attributes when OpenStack Networking is deployed
12// with a particular plug-in. The examples shown in this chapter refer to the
13// Open vSwitch plug-in.
14//
15// The default policy settings enable only users with administrative rights to
16// specify these parameters in requests and to see their values in responses. By
17// default, the provider network extension attributes are completely hidden from
18// regular tenants. As a rule of thumb, if these attributes are not visible in a
19// GET /networks/<network-id> operation, this implies the user submitting the
20// request is not authorized to view or manipulate provider network attributes.
21package provider