Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. devices
  5. LiveToolsCable
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.devices.LiveToolsCable

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

    Create LiveToolsCable Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LiveToolsCable(name: string, args: LiveToolsCableArgs, opts?: CustomResourceOptions);
    @overload
def LiveToolsCable(resource_name: str,
                   args: LiveToolsCableArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def LiveToolsCable(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   serial: Optional[str] = None,
                   callback: Optional[LiveToolsCableCallbackArgs] = None,
                   ports: Optional[Sequence[str]] = None)
    func NewLiveToolsCable(ctx *Context, name string, args LiveToolsCableArgs, opts ...ResourceOption) (*LiveToolsCable, error)
    public LiveToolsCable(string name, LiveToolsCableArgs args, CustomResourceOptions? opts = null)
    public LiveToolsCable(String name, LiveToolsCableArgs args)
public LiveToolsCable(String name, LiveToolsCableArgs args, CustomResourceOptions options)

    type: meraki:devices:LiveToolsCable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LiveToolsCableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LiveToolsCableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LiveToolsCableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LiveToolsCableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LiveToolsCableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var liveToolsCableResource = new Meraki.Devices.LiveToolsCable("liveToolsCableResource", new()
{
    Serial = "string",
    Callback = new Meraki.Devices.Inputs.LiveToolsCableCallbackArgs
    {
        HttpServer = new Meraki.Devices.Inputs.LiveToolsCableCallbackHttpServerArgs
        {
            Id = "string",
        },
        PayloadTemplate = new Meraki.Devices.Inputs.LiveToolsCableCallbackPayloadTemplateArgs
        {
            Id = "string",
        },
        SharedSecret = "string",
        Url = "string",
    },
    Ports = new[]
    {
        "string",
    },
});

    example, err := devices.NewLiveToolsCable(ctx, "liveToolsCableResource", &devices.LiveToolsCableArgs{
	Serial: pulumi.String("string"),
	Callback: &devices.LiveToolsCableCallbackArgs{
		HttpServer: &devices.LiveToolsCableCallbackHttpServerArgs{
			Id: pulumi.String("string"),
		},
		PayloadTemplate: &devices.LiveToolsCableCallbackPayloadTemplateArgs{
			Id: pulumi.String("string"),
		},
		SharedSecret: pulumi.String("string"),
		Url:          pulumi.String("string"),
	},
	Ports: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var liveToolsCableResource = new LiveToolsCable("liveToolsCableResource", LiveToolsCableArgs.builder()
    .serial("string")
    .callback(LiveToolsCableCallbackArgs.builder()
        .httpServer(LiveToolsCableCallbackHttpServerArgs.builder()
            .id("string")
            .build())
        .payloadTemplate(LiveToolsCableCallbackPayloadTemplateArgs.builder()
            .id("string")
            .build())
        .sharedSecret("string")
        .url("string")
        .build())
    .ports("string")
    .build());

    live_tools_cable_resource = meraki.devices.LiveToolsCable("liveToolsCableResource",
    serial="string",
    callback={
        "http_server": {
            "id": "string",
        },
        "payload_template": {
            "id": "string",
        },
        "shared_secret": "string",
        "url": "string",
    },
    ports=["string"])

    const liveToolsCableResource = new meraki.devices.LiveToolsCable("liveToolsCableResource", {
    serial: "string",
    callback: {
        httpServer: {
            id: "string",
        },
        payloadTemplate: {
            id: "string",
        },
        sharedSecret: "string",
        url: "string",
    },
    ports: ["string"],
});

    type: meraki:devices:LiveToolsCable
properties:
    callback:
        httpServer:
            id: string
        payloadTemplate:
            id: string
        sharedSecret: string
        url: string
    ports:
        - string
    serial: string

    LiveToolsCable Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LiveToolsCable resource accepts the following input properties:

    Serial string
    serial path parameter.
    Callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Ports List<string>
    A list of ports for which to perform the cable test.
    Serial string
    serial path parameter.
    Callback LiveToolsCableCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Ports []string
    A list of ports for which to perform the cable test.
    serial String
    serial path parameter.
    callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ports List<String>
    A list of ports for which to perform the cable test.
    serial string
    serial path parameter.
    callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ports string[]
    A list of ports for which to perform the cable test.
    serial str
    serial path parameter.
    callback LiveToolsCableCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ports Sequence[str]
    A list of ports for which to perform the cable test.
    serial String
    serial path parameter.
    callback Property Map
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ports List<String>
    A list of ports for which to perform the cable test.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LiveToolsCable resource produces the following output properties:

    CableTestId string
    Id of the cable test request. Used to check the status of the request.
    Error string
    An error message for a failed execution
    Id string
    The provider-assigned unique ID for this managed resource.
    Request LiveToolsCableRequest
    Cable test request parameters
    Results List<LiveToolsCableResult>
    Results of the cable test request, one for each requested port.
    Status string
    Status of the cable test request.
    Url string
    GET this url to check the status of your cable test request.
    CableTestId string
    Id of the cable test request. Used to check the status of the request.
    Error string
    An error message for a failed execution
    Id string
    The provider-assigned unique ID for this managed resource.
    Request LiveToolsCableRequest
    Cable test request parameters
    Results []LiveToolsCableResult
    Results of the cable test request, one for each requested port.
    Status string
    Status of the cable test request.
    Url string
    GET this url to check the status of your cable test request.
    cableTestId String
    Id of the cable test request. Used to check the status of the request.
    error String
    An error message for a failed execution
    id String
    The provider-assigned unique ID for this managed resource.
    request LiveToolsCableRequest
    Cable test request parameters
    results List<LiveToolsCableResult>
    Results of the cable test request, one for each requested port.
    status String
    Status of the cable test request.
    url String
    GET this url to check the status of your cable test request.
    cableTestId string
    Id of the cable test request. Used to check the status of the request.
    error string
    An error message for a failed execution
    id string
    The provider-assigned unique ID for this managed resource.
    request LiveToolsCableRequest
    Cable test request parameters
    results LiveToolsCableResult[]
    Results of the cable test request, one for each requested port.
    status string
    Status of the cable test request.
    url string
    GET this url to check the status of your cable test request.
    cable_test_id str
    Id of the cable test request. Used to check the status of the request.
    error str
    An error message for a failed execution
    id str
    The provider-assigned unique ID for this managed resource.
    request LiveToolsCableRequest
    Cable test request parameters
    results Sequence[LiveToolsCableResult]
    Results of the cable test request, one for each requested port.
    status str
    Status of the cable test request.
    url str
    GET this url to check the status of your cable test request.
    cableTestId String
    Id of the cable test request. Used to check the status of the request.
    error String
    An error message for a failed execution
    id String
    The provider-assigned unique ID for this managed resource.
    request Property Map
    Cable test request parameters
    results List<Property Map>
    Results of the cable test request, one for each requested port.
    status String
    Status of the cable test request.
    url String
    GET this url to check the status of your cable test request.

    Look up Existing LiveToolsCable Resource

    Get an existing LiveToolsCable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: LiveToolsCableState, opts?: CustomResourceOptions): LiveToolsCable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cable_test_id: Optional[str] = None,
        callback: Optional[LiveToolsCableCallbackArgs] = None,
        error: Optional[str] = None,
        ports: Optional[Sequence[str]] = None,
        request: Optional[LiveToolsCableRequestArgs] = None,
        results: Optional[Sequence[LiveToolsCableResultArgs]] = None,
        serial: Optional[str] = None,
        status: Optional[str] = None,
        url: Optional[str] = None) -> LiveToolsCable
    func GetLiveToolsCable(ctx *Context, name string, id IDInput, state *LiveToolsCableState, opts ...ResourceOption) (*LiveToolsCable, error)
    public static LiveToolsCable Get(string name, Input<string> id, LiveToolsCableState? state, CustomResourceOptions? opts = null)
    public static LiveToolsCable get(String name, Output<String> id, LiveToolsCableState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CableTestId string
    Id of the cable test request. Used to check the status of the request.
    Callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Error string
    An error message for a failed execution
    Ports List<string>
    A list of ports for which to perform the cable test.
    Request LiveToolsCableRequest
    Cable test request parameters
    Results List<LiveToolsCableResult>
    Results of the cable test request, one for each requested port.
    Serial string
    serial path parameter.
    Status string
    Status of the cable test request.
    Url string
    GET this url to check the status of your cable test request.
    CableTestId string
    Id of the cable test request. Used to check the status of the request.
    Callback LiveToolsCableCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Error string
    An error message for a failed execution
    Ports []string
    A list of ports for which to perform the cable test.
    Request LiveToolsCableRequestArgs
    Cable test request parameters
    Results []LiveToolsCableResultArgs
    Results of the cable test request, one for each requested port.
    Serial string
    serial path parameter.
    Status string
    Status of the cable test request.
    Url string
    GET this url to check the status of your cable test request.
    cableTestId String
    Id of the cable test request. Used to check the status of the request.
    callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error String
    An error message for a failed execution
    ports List<String>
    A list of ports for which to perform the cable test.
    request LiveToolsCableRequest
    Cable test request parameters
    results List<LiveToolsCableResult>
    Results of the cable test request, one for each requested port.
    serial String
    serial path parameter.
    status String
    Status of the cable test request.
    url String
    GET this url to check the status of your cable test request.
    cableTestId string
    Id of the cable test request. Used to check the status of the request.
    callback LiveToolsCableCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error string
    An error message for a failed execution
    ports string[]
    A list of ports for which to perform the cable test.
    request LiveToolsCableRequest
    Cable test request parameters
    results LiveToolsCableResult[]
    Results of the cable test request, one for each requested port.
    serial string
    serial path parameter.
    status string
    Status of the cable test request.
    url string
    GET this url to check the status of your cable test request.
    cable_test_id str
    Id of the cable test request. Used to check the status of the request.
    callback LiveToolsCableCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error str
    An error message for a failed execution
    ports Sequence[str]
    A list of ports for which to perform the cable test.
    request LiveToolsCableRequestArgs
    Cable test request parameters
    results Sequence[LiveToolsCableResultArgs]
    Results of the cable test request, one for each requested port.
    serial str
    serial path parameter.
    status str
    Status of the cable test request.
    url str
    GET this url to check the status of your cable test request.
    cableTestId String
    Id of the cable test request. Used to check the status of the request.
    callback Property Map
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error String
    An error message for a failed execution
    ports List<String>
    A list of ports for which to perform the cable test.
    request Property Map
    Cable test request parameters
    results List<Property Map>
    Results of the cable test request, one for each requested port.
    serial String
    serial path parameter.
    status String
    Status of the cable test request.
    url String
    GET this url to check the status of your cable test request.

    Supporting Types

    LiveToolsCableCallback, LiveToolsCableCallbackArgs

    HttpServer LiveToolsCableCallbackHttpServer
    The webhook receiver used for the callback webhook.
    PayloadTemplate LiveToolsCableCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    SharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    Url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    HttpServer LiveToolsCableCallbackHttpServer
    The webhook receiver used for the callback webhook.
    PayloadTemplate LiveToolsCableCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    SharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    Url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer LiveToolsCableCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payloadTemplate LiveToolsCableCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    sharedSecret String
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url String
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer LiveToolsCableCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payloadTemplate LiveToolsCableCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    sharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    http_server LiveToolsCableCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payload_template LiveToolsCableCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    shared_secret str
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url str
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer Property Map
    The webhook receiver used for the callback webhook.
    payloadTemplate Property Map
    The payload template of the webhook used for the callback
    sharedSecret String
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url String
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

    LiveToolsCableCallbackHttpServer, LiveToolsCableCallbackHttpServerArgs

    Id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    Id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id String
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id str
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id String
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

    LiveToolsCableCallbackPayloadTemplate, LiveToolsCableCallbackPayloadTemplateArgs

    Id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    Id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id String
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id str
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id String
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

    LiveToolsCableRequest, LiveToolsCableRequestArgs

    Ports List<string>
    A list of ports for which to perform the cable test.
    Serial string
    Device serial number
    Ports []string
    A list of ports for which to perform the cable test.
    Serial string
    Device serial number
    ports List<String>
    A list of ports for which to perform the cable test.
    serial String
    Device serial number
    ports string[]
    A list of ports for which to perform the cable test.
    serial string
    Device serial number
    ports Sequence[str]
    A list of ports for which to perform the cable test.
    serial str
    Device serial number
    ports List<String>
    A list of ports for which to perform the cable test.
    serial String
    Device serial number

    LiveToolsCableResult, LiveToolsCableResultArgs

    Error string
    If an error occurred during the cable test, the error message will be populated here.
    Pairs List<LiveToolsCableResultPair>
    Results for each twisted pair within the cable.
    Port string
    The port for which the test was performed.
    SpeedMbps int
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    Status string
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
    Error string
    If an error occurred during the cable test, the error message will be populated here.
    Pairs []LiveToolsCableResultPair
    Results for each twisted pair within the cable.
    Port string
    The port for which the test was performed.
    SpeedMbps int
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    Status string
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
    error String
    If an error occurred during the cable test, the error message will be populated here.
    pairs List<LiveToolsCableResultPair>
    Results for each twisted pair within the cable.
    port String
    The port for which the test was performed.
    speedMbps Integer
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    status String
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
    error string
    If an error occurred during the cable test, the error message will be populated here.
    pairs LiveToolsCableResultPair[]
    Results for each twisted pair within the cable.
    port string
    The port for which the test was performed.
    speedMbps number
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    status string
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
    error str
    If an error occurred during the cable test, the error message will be populated here.
    pairs Sequence[LiveToolsCableResultPair]
    Results for each twisted pair within the cable.
    port str
    The port for which the test was performed.
    speed_mbps int
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    status str
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.
    error String
    If an error occurred during the cable test, the error message will be populated here.
    pairs List<Property Map>
    Results for each twisted pair within the cable.
    port String
    The port for which the test was performed.
    speedMbps Number
    Speed in Mbps. A speed of 0 indicates the port is down or the port speed is automatic.
    status String
    The current status of the port. If the cable test is still being performed on the port, "in-progress" is used. If an error occurred during the cable test, "error" is used and the error property will be populated.

    LiveToolsCableResultPair, LiveToolsCableResultPairArgs

    Index int
    The index of the twisted pair tested.
    LengthMeters int
    The detected length of the twisted pair.
    Status string
    The test result of the twisted pair tested.
    Index int
    The index of the twisted pair tested.
    LengthMeters int
    The detected length of the twisted pair.
    Status string
    The test result of the twisted pair tested.
    index Integer
    The index of the twisted pair tested.
    lengthMeters Integer
    The detected length of the twisted pair.
    status String
    The test result of the twisted pair tested.
    index number
    The index of the twisted pair tested.
    lengthMeters number
    The detected length of the twisted pair.
    status string
    The test result of the twisted pair tested.
    index int
    The index of the twisted pair tested.
    length_meters int
    The detected length of the twisted pair.
    status str
    The test result of the twisted pair tested.
    index Number
    The index of the twisted pair tested.
    lengthMeters Number
    The detected length of the twisted pair.
    status String
    The test result of the twisted pair tested.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-meraki