Enables or disables a network fabric plan

Enables or disables a network fabric plan

Path Parameters

name stringrequired

Name of a network fabric plan

application/json

Request Body required

Definition of the Plan to enable/disable

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion stringrequired
blockOwnerDeletion boolean
controller boolean
kind stringrequired
name stringrequired
uid stringrequired
resourceVersion string
selfLink string
uid string
spec
NetworkFabricPlanSpec defines the desired state of Plan
allocation
type stringrequired
workspaces string[]
labels object
property name* string
planProviderDetails
PlanProviderDetails defines the parameters for cloud specific options specifically for a plan
aws
AWS is the provider specification for AWS networks
availabilityZoneIDsByRegion object
AvailabilityZoneIDsByRegion is a map of region to availability zone IDs. Allows specifying which zones should be used across accounts when networks are created.
type
items string
policies undefined[]
editable boolean
enum string[]
max int64
min int64
path string
pattern string
summary string
reclaimPolicy
ReclaimPolicy defines when a network should be reclaimed and not created
prefix string
suffix string
type stringrequired
summary stringrequired
template required
Template are the key+value pairs describing a network configuration
cloudAccessConfigRef
CloudAccessConfigRef is a reference to the cloud access configuration that should be used to create the network.
name stringrequired
namespace stringrequired
cloudResourceName string
ipv4 required
IPv4 contains the IPv4 configuration associated with the network.
cidrBlocks undefined[]
CIDRBlocks is a list of CIDR blocks that are associated with the network. Includes useCase so a provider or client can decide what they are used for currently only supported use cases are: - "cluster" - "pods" - "services" [AWS] Multiple IP ranges. AWS only supports a single IP range is supported on creation, but can be updated afterwards to specify additional IP ranges. [GCP] Used as metadata for cluster creation. [Azure] Multiple IP ranges.
cidr stringrequired
size int32required
type stringrequired
layout required
Layout refers to the layout of the network. It controls whether the various parts - subnets, routes, etc. - are set up manually (i.e. specified in the spec) or automatically (i.e. generated by the provider).
mode string
privateSubnets int32
publicSubnets int32
location stringrequired
plan string
private
Private are options related to private networking
enabled boolean
gateways undefined[]
Gateways provides the options around cloud NAT gateways
associate required
Associate is the location of the gateway
location string
subnet string
ipv4 required
IPv4 defines the ip allocation options of the gateway
addresses string[]
mode stringrequired
nat
NAT provides cloud agnostic settings for the NAT gateway itself
subnets string[]
provider stringrequired
providerDetails
ProviderDetails defines cloud-specific network options
aws
AWS is the provider specification for AWS networks
availabilityZoneIDs string[]
availabilityZones int32
natGateways int32
readOnly
ReadOnly is the read only configuration Used when auditing the network fabric from a real VPC
privateSubnetIDs string[]
publicSubnetIDs string[]
securityGroupIDs string[]
vpcID stringrequired
azure
Azure is the provider specification for Azure networks
resourceGroup stringrequired
gcp
type stringrequired
routes undefined[]
Routes is the list of routes within the network. Mode must be set to "manual" for this field to be valid. if manual, will be populated from the spec.IPv4.CIDRBlock's
cidrBlock stringrequired
description string
name stringrequired
target required
stage stringrequired
subnets undefined[]
Subnets is the list of subnets within the network. Mode must be set to "manual" for this field to be valid.
description string
ipv4 required
IPv4 is the Internet Protocol (version 4) configuration for the subnet.
cidrBlock stringrequired
ipVersion integer
providerDetails
ProviderDetails is is the cloud specific configuration for the subnet.
gcp
GCP is the provider specification for GCP subnets
secondaryIpRanges undefined[] required
cidrBlock stringrequired
type stringrequired
type stringrequired
location stringrequired
name stringrequired
tags object
Tags is a collection of tags to apply to the resources associated with the network, if applicable.
property name* string
status
NetworkFabricPlanStatus defines the observed state of Plan
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime stringrequired
message string
name stringrequired
negativePolarity boolean
observedGeneration int64
reason stringrequired
status stringrequired
type stringrequired
detail string
lastReconcile
generation int64required
time stringrequired
lastSuccess
generation int64required
time stringrequired
message string
obsoleteResources undefined[]
kind stringrequired
name stringrequired
status stringrequired
wayfinderVersion string

Responses

200

Plan successfully enabled or disabled

application/json

Schema

Schema

apiVersion string
kind string
metadata
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
annotations object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
property name* string
clusterName string
creationTimestamp string
deletionGracePeriodSeconds int64
deletionTimestamp string
finalizers string[]
generateName string
generation int64
labels object
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
property name* string
managedFields undefined[]
ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
apiVersion string
fieldsType string
fieldsV1 string
manager string
operation string
subresource string
time string
name string
namespace string
ownerReferences undefined[]
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
apiVersion string
blockOwnerDeletion boolean
controller boolean
kind string
name string
uid string
resourceVersion string
selfLink string
uid string
spec
NetworkFabricPlanSpec defines the desired state of Plan
allocation
type string
workspaces string[]
labels object
property name* string
planProviderDetails
PlanProviderDetails defines the parameters for cloud specific options specifically for a plan
aws
AWS is the provider specification for AWS networks
availabilityZoneIDsByRegion object
AvailabilityZoneIDsByRegion is a map of region to availability zone IDs. Allows specifying which zones should be used across accounts when networks are created.
type
items string
policies undefined[]
editable boolean
enum string[]
max int64
min int64
path string
pattern string
summary string
reclaimPolicy
ReclaimPolicy defines when a network should be reclaimed and not created
prefix string
suffix string
type string
summary string
template
Template are the key+value pairs describing a network configuration
cloudAccessConfigRef
CloudAccessConfigRef is a reference to the cloud access configuration that should be used to create the network.
name string
namespace string
cloudResourceName string
ipv4
IPv4 contains the IPv4 configuration associated with the network.
cidrBlocks undefined[]
CIDRBlocks is a list of CIDR blocks that are associated with the network. Includes useCase so a provider or client can decide what they are used for currently only supported use cases are: - "cluster" - "pods" - "services" [AWS] Multiple IP ranges. AWS only supports a single IP range is supported on creation, but can be updated afterwards to specify additional IP ranges. [GCP] Used as metadata for cluster creation. [Azure] Multiple IP ranges.
cidr string
size int32
type string
layout
Layout refers to the layout of the network. It controls whether the various parts - subnets, routes, etc. - are set up manually (i.e. specified in the spec) or automatically (i.e. generated by the provider).
mode string
privateSubnets int32
publicSubnets int32
location string
plan string
private
Private are options related to private networking
enabled boolean
gateways undefined[]
Gateways provides the options around cloud NAT gateways
associate
Associate is the location of the gateway
location string
subnet string
ipv4
IPv4 defines the ip allocation options of the gateway
addresses string[]
mode string
nat
NAT provides cloud agnostic settings for the NAT gateway itself
subnets string[]
provider string
providerDetails
ProviderDetails defines cloud-specific network options
aws
AWS is the provider specification for AWS networks
availabilityZoneIDs string[]
availabilityZones int32
natGateways int32
readOnly
ReadOnly is the read only configuration Used when auditing the network fabric from a real VPC
privateSubnetIDs string[]
publicSubnetIDs string[]
securityGroupIDs string[]
vpcID string
azure
Azure is the provider specification for Azure networks
resourceGroup string
gcp
type string
routes undefined[]
Routes is the list of routes within the network. Mode must be set to "manual" for this field to be valid. if manual, will be populated from the spec.IPv4.CIDRBlock's
cidrBlock string
description string
name string
target
stage string
subnets undefined[]
Subnets is the list of subnets within the network. Mode must be set to "manual" for this field to be valid.
description string
ipv4
IPv4 is the Internet Protocol (version 4) configuration for the subnet.
cidrBlock string
ipVersion integer
providerDetails
ProviderDetails is is the cloud specific configuration for the subnet.
gcp
GCP is the provider specification for GCP subnets
secondaryIpRanges undefined[]
cidrBlock string
type string
type string
location string
name string
tags object
Tags is a collection of tags to apply to the resources associated with the network, if applicable.
property name* string
status
NetworkFabricPlanStatus defines the observed state of Plan
cloudResourcesCreated boolean
conditions undefined[]
detail string
lastTransitionTime string
message string
name string
negativePolarity boolean
observedGeneration int64
reason string
status string
type string
detail string
lastReconcile
generation int64
time string
lastSuccess
generation int64
time string
message string
obsoleteResources undefined[]
kind string
name string
status string
wayfinderVersion string

Example (from schema)

{
  "apiVersion": "string",
  "kind": "string",
  "metadata": {
    "annotations": {},
    "clusterName": "string",
    "creationTimestamp": "string",
    "deletionGracePeriodSeconds": 0,
    "deletionTimestamp": "string",
    "finalizers": [
      "string"
    ],
    "generateName": "string",
    "generation": 0,
    "labels": {},
    "managedFields": [
      {
        "apiVersion": "string",
        "fieldsType": "string",
        "fieldsV1": "string",
        "manager": "string",
        "operation": "string",
        "subresource": "string",
        "time": "string"
      }
    ],
    "name": "string",
    "namespace": "string",
    "ownerReferences": [
      {
        "apiVersion": "string",
        "blockOwnerDeletion": true,
        "controller": true,
        "kind": "string",
        "name": "string",
        "uid": "string"
      }
    ],
    "resourceVersion": "string",
    "selfLink": "string",
    "uid": "string"
  },
  "spec": {
    "allocation": {
      "type": "string",
      "workspaces": [
        "string"
      ]
    },
    "labels": {},
    "planProviderDetails": {
      "aws": {
        "availabilityZoneIDsByRegion": {}
      }
    },
    "policies": [
      {
        "editable": true,
        "enum": [
          "string"
        ],
        "max": 0,
        "min": 0,
        "path": "string",
        "pattern": "string",
        "summary": "string"
      }
    ],
    "reclaimPolicy": {
      "prefix": "string",
      "suffix": "string",
      "type": "string"
    },
    "summary": "string",
    "template": {
      "cloudAccessConfigRef": {
        "name": "string",
        "namespace": "string"
      },
      "cloudResourceName": "string",
      "ipv4": {
        "cidrBlocks": [
          {
            "cidr": "string",
            "size": 0,
            "type": "string"
          }
        ]
      },
      "layout": {
        "mode": "string",
        "privateSubnets": 0,
        "publicSubnets": 0
      },
      "location": "string",
      "plan": "string",
      "private": {
        "enabled": true,
        "gateways": [
          {
            "associate": {
              "location": "string",
              "subnet": "string"
            },
            "ipv4": {
              "addresses": [
                "string"
              ],
              "mode": "string"
            },
            "nat": {
              "subnets": [
                "string"
              ]
            }
          }
        ]
      },
      "provider": "string",
      "providerDetails": {
        "aws": {
          "availabilityZoneIDs": [
            "string"
          ],
          "availabilityZones": 0,
          "natGateways": 0,
          "readOnly": {
            "privateSubnetIDs": [
              "string"
            ],
            "publicSubnetIDs": [
              "string"
            ],
            "securityGroupIDs": [
              "string"
            ],
            "vpcID": "string"
          }
        },
        "azure": {
          "resourceGroup": "string"
        },
        "type": "string"
      },
      "routes": [
        {
          "cidrBlock": "string",
          "description": "string",
          "name": "string"
        }
      ],
      "stage": "string",
      "subnets": [
        {
          "description": "string",
          "ipv4": {
            "cidrBlock": "string",
            "ipVersion": 0,
            "providerDetails": {
              "gcp": {
                "secondaryIpRanges": [
                  {
                    "cidrBlock": "string",
                    "type": "string"
                  }
                ]
              }
            },
            "type": "string"
          },
          "location": "string",
          "name": "string"
        }
      ],
      "tags": {}
    }
  },
  "status": {
    "cloudResourcesCreated": true,
    "conditions": [
      {
        "detail": "string",
        "lastTransitionTime": "string",
        "message": "string",
        "name": "string",
        "negativePolarity": true,
        "observedGeneration": 0,
        "reason": "string",
        "status": "string",
        "type": "string"
      }
    ],
    "detail": "string",
    "lastReconcile": {
      "generation": 0,
      "time": "string"
    },
    "lastSuccess": {
      "generation": 0,
      "time": "string"
    },
    "message": "string",
    "obsoleteResources": [
      {
        "kind": "string",
        "name": "string"
      }
    ],
    "status": "string",
    "wayfinderVersion": "string"
  }
}

400

Validation error of supplied parameters/body

application/json

Schema

Schema

code int32
fieldErrors undefined[]
errCode string
field string
message string
message string

Example (from schema)

{
  "code": 0,
  "fieldErrors": [
    {
      "errCode": "string",
      "field": "string",
      "message": "string"
    }
  ],
  "message": "string"
}

401

If not authenticated

403

If authenticated but not authorized

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32
detail string
message string
uri string
verb string

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...