Perform a switchover - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Perform a switchover","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/40d706fd-9f3a-3ab1-a34b-943159096796","info":{"title":"Crosswork Crosscluster Service APIs","description":"Cross cluster provides API methods for handling geo synchronization, leadership operations, and multi-cluster showtech collection on 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/CROSSCLUSTER/crosscluster-overview.md"}},"swagger":"2.0","basePath":"/crosswork/crosscluster/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Security definitions details."}}},"spec":{"summary":"Perform a switchover","description":"Perform a switchover, which consists of three steps: set role on the LHS, set role on the RHS, and update the DNS\nserver with the provided binary from the set settings request. Note that this API is only supported if auto\narbitration is enabled.","operationId":"CrossClusterManager_SwitchoverCrossCluster","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"job_id":{"type":"string","title":"Job id"},"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":"Result"}},"description":"Response payload from switchover API which contains the job ID upon successful requests.","$$ref":"#/definitions/crosscluster_serviceSwitchoverCrossClusterResponse"},"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":"Cross cluster service switchover request data","schema":{"type":"object","properties":{"crosscluster_switchover_assignments":{"description":"cluster leadership assignments.","type":"object","properties":{"crosscluster_switchover_assignments":{"type":"array","items":{"type":"object","properties":{"cross_cluster_component":{"type":"object","properties":{"id":{"type":"string","description":"Cluster id is required if component is CROSSWORK_CLUSTER, otherwise it can be left empty."},"name":{"type":"string","description":"CrossCluster component name.\nNOTE: not supported in showtech requests and should be left empty."},"component_type":{"title":"Component for log collection","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":"Crosscluster component","$$ref":"#/definitions/common_geo_platformCrossClusterComponent"},"preferred_cluster_leadership_state":{"title":"Leadership state of the cluster","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","description":"- ACTIVE: Denotes cluster leadership state\n - STANDBY: Denotes standby cluster\n - TENTATIVE: Tentative - transient state\n - STANDBY_WITH_FAILURES: System is in standby but has failures\n - ACTIVE_WITH_FAILURES: System is in active but has failures\n - TRANSITIONING_TO_ACTIVE: ACTIVE TRANSITION - transient state\n - TRANSITIONING_TO_STANDBY: STANDBY TRANSITION - transient state","$$ref":"#/definitions/common_geo_platformCrossClusterLeadershipState"},"force":{"type":"boolean","description":"Allows switchover to be forced even if errors are encountered."}},"description":"CrossClusterSwitchoverAssignment is a single cluster's leadership assignment\nintent for the cluster identified in the payload.","$$ref":"#/definitions/common_geo_platformCrossClusterSwitchoverAssignment"}}},"$$ref":"#/definitions/common_geo_platformCrossClusterSwitchoverAssignments"}},"description":"Request payload from switchover API. Note that the request includes both sides\n(LHS and RHS) leadership roles as input to make everything explicit. Arbiter\ninput is not required.","$$ref":"#/definitions/crosscluster_serviceSwitchoverCrossClusterRequest"}}],"tags":["CrossClusterManager"],"__originalOperationId":"CrossClusterManager_SwitchoverCrossCluster","consumes":["application/json"],"produces":["application/json"],"method":"post","path":"/switchover"}}