Enable to geo mode - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Enable to geo mode","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/50f8c0a7-834c-37e0-9e1d-1eb33720ae56","info":{"title":"Geo Redundancy Service APIs","description":"Geo manager provides API methods for enabling and updating the geo redundancy HA across Crosswork.","version":"3.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/GEO/geo-redundancy-overview.md"}},"swagger":"2.0","basePath":"/crosswork/platform/v2","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Security definitions details."}}},"spec":{"summary":"Enable to geo mode","description":"Allows user to enable to geo mode in cluster on Day 1 where no devices, dg and apps are installed.\nOnce enabled , cannot be disabled.","operationId":"GeoRedundancyManager_ActivateGeoMode","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"job_id":{"type":"string","title":"Job id"},"result":{"title":"Result","type":"object","properties":{"request_result":{"description":"ResultValue indicated accept/reject for a request, not the outcome of the work itself.","type":"string","enum":["UNKNOWN_RESULT","REJECTED","ACCEPTED"],"default":"UNKNOWN_RESULT","title":"Request - reply\nresponse","$$ref":"#/definitions/common_geo_platformRequestResult"},"error":{"description":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI.","type":"object","properties":{"message":{"type":"string","title":"Message is a textual description of reason for rejection, and can be safely passed on to operator through logs\nor UI"}},"title":"Error associated with an Object","$$ref":"#/definitions/common_geo_platformError"}},"description":"Result is used to convey whether an operation (individual or in a batch)\nhas been accepted or rejected. For sync API's an error or rejection indicates failure of operation.\nA string error message accompanies rejection to support troubleshooting. For notification objects,\nrejection represents failure to do intended operation.","$$ref":"#/definitions/common_geo_platformResult"}},"title":"Activate Geo Mode response","$$ref":"#/definitions/geo_redundancy_serviceActivateGeoModeResponse"},"examples":{"example":{"job_id":"DJ1","result":{"request_result":"ACCEPTED","error":{}}}}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","format":"byte","description":"Must be a valid serialized protocol buffer of the above specified type."}},"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }","$$ref":"#/definitions/protobufAny"}}},"$$ref":"#/definitions/gatewayruntimeError"},"examples":{"example":{"error":"","code":13,"message":"failed to marshal error message","details":[]}}}},"parameters":[{"name":"body","in":"body","required":true,"description":"Geo redudancy service activate geo mode request data","schema":{"type":"object","properties":{"cross_cluster_inventory":{"title":"Crosscluster inventory for enrollment","type":"object","properties":{"meta_version":{"type":"string","title":"meta version"},"crosscluster_id":{"type":"string","title":"Crosscluster id - Immutable"},"crosscluster_name":{"type":"string","title":"Crosscluster name - Mutable"},"clusters":{"type":"array","items":{"type":"object","properties":{"cluster_id":{"type":"string","title":"cluster id"},"cluster_name":{"type":"string","title":"cluster name"},"initial_preferred_leadership_state":{"description":"Initial Leadership state of the cluster. This will also be used as seed node for CA.","type":"string","enum":["UNKNOWN_CLUSTER_LEADER_STATE","ACTIVE","STANDBY","TENTATIVE","STANDBY_WITH_FAILURES","ACTIVE_WITH_FAILURES","TRANSITIONING_TO_ACTIVE","TRANSITIONING_TO_STANDBY"],"default":"UNKNOWN_CLUSTER_LEADER_STATE","title":"CrossCluster leadership state","$$ref":"#/definitions/common_geo_platformCrossClusterLeadershipState"},"connectivity":{"title":"Cluster connectivity","type":"object","properties":{"unified_end_point":{"title":"Cluster connect endpoint type","type":"object","properties":{"unified_endpoint_type":{"title":"Cluster endpoint type","type":"object","properties":{"fqdn_type":{"title":"Fqdn","type":"object","$$ref":"#/definitions/common_geo_platformFqdnType"},"ip_type":{"title":"ip","type":"object","$$ref":"#/definitions/common_geo_platformIPType"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPointType"},"unified_endpoint_implementation":{"title":"Cluster endpoint implementation","type":"string","enum":["UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","DNS","BGP","VRRP"],"default":"UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","description":"Supported combination for IntraCluster on prem\nIP_TYPE,VRRP\nSupported combination for IntraCluster Cloud\nFQDN_TYPE,NLB\n\nPotential Valid combinations for CrossCluster in future\nFQDN_TYPE,NLB\nIP_TYPE,VRRP\nIP_TYPE,BGP\nIP_TYPE,NLB\n\n - DNS: DNS is used to service unified cluster endpoint\n - BGP: // BGP\n - VRRP: // VRRP","$$ref":"#/definitions/common_geo_platformUnifiedEndPointImplementation"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPoint"},"management_vip":{"type":"string","title":"Management VIP"},"management_vip_mask":{"type":"string","format":"uint64","title":"management subnet mask"},"data_vip":{"type":"string","title":"Data VIP"},"data_vip_mask":{"type":"string","format":"uint64","title":"management subnet mask"},"management_fqdn":{"title":"Management FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"},"data_fqdn":{"title":"Data FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"},"management_vip_ipv4":{"type":"string","title":"Management VIP IPv4"},"management_vip_ipv4_mask":{"type":"string","format":"uint64","title":"Management VIP IPv4 subnet mask"},"data_vip_ipv4":{"type":"string","title":"Data VIP IPv4"},"data_vip_ipv4_mask":{"type":"string","format":"uint64","title":"Data VIP IPv4 subnet mask"},"management_vip_ipv6":{"type":"string","title":"Management VIP IPv6"},"management_vip_ipv6_mask":{"type":"string","format":"uint64","title":"Management VIP IPv6 subnet mask"},"data_vip_ipv6":{"type":"string","title":"Data VIP IPv6"},"data_vip_ipv6_mask":{"type":"string","format":"uint64","title":"Data VIP IPv6 subnet mask"}},"$$ref":"#/definitions/common_geo_platformConnectivity"},"site_location":{"title":"Site location","type":"object","properties":{"location":{"type":"string","title":"// Availability zone , populated per cross cluster component, List of 1 or 3\n repeated string availability_zones = 1;\n // Region , populated per cross cluster component\n string region = 2;\nMaps to Datacenter location for on prem, for cloud leverage `az,region` name"}},"$$ref":"#/definitions/common_geo_platformSiteLocation"},"cluster_credential":{"title":"Cross work credential","type":"object","properties":{"ssh_credential":{"title":"SSH credential","type":"object","properties":{"username":{"type":"string","title":"username"},"password":{"type":"string","title":"password"}},"$$ref":"#/definitions/common_geo_platformSSHCredential"},"https_credential":{"title":"Https credential","type":"object","properties":{"username":{"type":"string","title":"username"},"password":{"type":"string","title":"password"}},"$$ref":"#/definitions/common_geo_platformHttpsCredential"}},"$$ref":"#/definitions/common_geo_platformClusterCredential"},"cluster_node_details":{"type":"array","items":{"type":"object","properties":{"unified_end_point":{"title":"Cluster connect endpoint type","type":"object","properties":{"unified_endpoint_type":{"title":"Cluster endpoint type","type":"object","properties":{"fqdn_type":{"title":"Fqdn","type":"object","$$ref":"#/definitions/common_geo_platformFqdnType"},"ip_type":{"title":"ip","type":"object","$$ref":"#/definitions/common_geo_platformIPType"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPointType"},"unified_endpoint_implementation":{"title":"Cluster endpoint implementation","type":"string","enum":["UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","DNS","BGP","VRRP"],"default":"UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","description":"Supported combination for IntraCluster on prem\nIP_TYPE,VRRP\nSupported combination for IntraCluster Cloud\nFQDN_TYPE,NLB\n\nPotential Valid combinations for CrossCluster in future\nFQDN_TYPE,NLB\nIP_TYPE,VRRP\nIP_TYPE,BGP\nIP_TYPE,NLB\n\n - DNS: DNS is used to service unified cluster endpoint\n - BGP: // BGP\n - VRRP: // VRRP","$$ref":"#/definitions/common_geo_platformUnifiedEndPointImplementation"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPoint"},"data_ipv4":{"type":"string","title":"Data IPv4"},"data_ipv4_mask":{"type":"string","format":"uint64","title":"Data IPv4 subnet mask"},"management_ipv4":{"type":"string","title":"Management IPv4"},"management_ipv4_mask":{"type":"string","format":"uint64","title":"Management IPv4 subnet mask"},"data_ipv6":{"type":"string","title":"Data IPv6"},"data_ipv6_mask":{"type":"string","format":"uint64","title":"Data IPv6 subnet mask"},"management_ipv6":{"type":"string","title":"Management IPv6"},"management_ipv6_mask":{"type":"string","format":"uint64","title":"Management IPv6 subnet mask"},"data_fqdn":{"title":"Data FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"},"management_fqdn":{"title":"Management FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"}},"$$ref":"#/definitions/common_geo_platformClusterNodeDetails"},"title":"This includes management and data ip of cluster"},"cluster_type":{"title":"Component type of the cluster","type":"string","enum":["UNKNOWN_COMPONENT","CROSSWORK_CLUSTER","ARBITER"],"default":"UNKNOWN_COMPONENT","description":"- CROSSWORK_CLUSTER: Crosswork cluster\n - ARBITER: Arbiter node","$$ref":"#/definitions/common_geo_platformComponentType"}},"title":"Cluster info","$$ref":"#/definitions/common_geo_platformCluster"},"title":"List of clusters which form the cluster - Immutable other than name field"},"secret":{"type":"string","title":"Secret message needed for multi cluster discovery - Mutable"},"crosscluster_unified_connectivity":{"title":"Crosscluster connectivity such as fqdn - Immutable","type":"object","properties":{"unified_end_point":{"title":"Cluster connect endpoint type","type":"object","properties":{"unified_endpoint_type":{"title":"Cluster endpoint type","type":"object","properties":{"fqdn_type":{"title":"Fqdn","type":"object","$$ref":"#/definitions/common_geo_platformFqdnType"},"ip_type":{"title":"ip","type":"object","$$ref":"#/definitions/common_geo_platformIPType"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPointType"},"unified_endpoint_implementation":{"title":"Cluster endpoint implementation","type":"string","enum":["UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","DNS","BGP","VRRP"],"default":"UNKNOWN_ENDPOINT_IMPLEMENTATION_TYPE","description":"Supported combination for IntraCluster on prem\nIP_TYPE,VRRP\nSupported combination for IntraCluster Cloud\nFQDN_TYPE,NLB\n\nPotential Valid combinations for CrossCluster in future\nFQDN_TYPE,NLB\nIP_TYPE,VRRP\nIP_TYPE,BGP\nIP_TYPE,NLB\n\n - DNS: DNS is used to service unified cluster endpoint\n - BGP: // BGP\n - VRRP: // VRRP","$$ref":"#/definitions/common_geo_platformUnifiedEndPointImplementation"}},"$$ref":"#/definitions/common_geo_platformUnifiedEndPoint"},"management_vip":{"type":"string","title":"Management VIP"},"management_vip_mask":{"type":"string","format":"uint64","title":"management subnet mask"},"data_vip":{"type":"string","title":"Data VIP"},"data_vip_mask":{"type":"string","format":"uint64","title":"management subnet mask"},"management_fqdn":{"title":"Management FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"},"data_fqdn":{"title":"Data FQDN","type":"object","properties":{"host_name":{"type":"string","title":"host name"},"domain_name":{"type":"string","title":"Domain name"}},"$$ref":"#/definitions/common_geo_platformFQDN"},"management_vip_ipv4":{"type":"string","title":"Management VIP IPv4"},"management_vip_ipv4_mask":{"type":"string","format":"uint64","title":"Management VIP IPv4 subnet mask"},"data_vip_ipv4":{"type":"string","title":"Data VIP IPv4"},"data_vip_ipv4_mask":{"type":"string","format":"uint64","title":"Data VIP IPv4 subnet mask"},"management_vip_ipv6":{"type":"string","title":"Management VIP IPv6"},"management_vip_ipv6_mask":{"type":"string","format":"uint64","title":"Management VIP IPv6 subnet mask"},"data_vip_ipv6":{"type":"string","title":"Data VIP IPv6"},"data_vip_ipv6_mask":{"type":"string","format":"uint64","title":"Data VIP IPv6 subnet mask"}},"$$ref":"#/definitions/common_geo_platformConnectivity"},"is_post_migration_activation":{"type":"boolean","title":"Set this to true , if one is enabling geo mode on a system post migration setup, rather than a fresh first time\ninstall"},"is_skip_peer_check_enabled":{"type":"boolean","title":"Skips peer login check for standby cluster,use it only for multi cluster DR"}},"$$ref":"#/definitions/common_geo_platformCrossClusterInventory"},"data":{"type":"string","format":"byte","title":"yaml file bytes (base64 encoded file content)"}},"title":"Active Geo Mode request","$$ref":"#/definitions/geo_redundancy_serviceActivateGeoModeRequest"}}],"tags":["GeoRedundancyManager"],"__originalOperationId":"GeoRedundancyManager_ActivateGeoMode","consumes":["application/json"],"produces":["application/json"],"method":"put","path":"/georedundancy/geomode/activate"}}