keychaincredential.create
=========================

Create a Keychain Credential.

The following `type`s are supported: * `SSH_KEY_PAIR` * `SSH_CREDENTIALS`

.. examples(websocket)::

    :::javascript {
        "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "keychaincredential.create", "params": [{ "name": "Work SSH connection", "type": "SSH_CREDENTIALS", "attributes": { "host": "work.freenas.org", "private_key": 12, "remote_host_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMn1VjdSMatGnxbOsrneKyai+dh6d4Hm" }
        }] }

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: keychain_credential_create</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>keychain_credential_create</h4><br/> <div class="any-of-value" id="Call_parameters_items_i0_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i0" id="Call_parameters_items_i0_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0')" role="tab">KeychainCredentialCreateSSHKeyPairEntry</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i1" id="Call_parameters_items_i0_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1')" role="tab">KeychainCredentialCreateSSHCredentialsEntry</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_anyOf_i0" role="tabpanel"> <h4>KeychainCredentialCreateSSHKeyPairEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_name"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_name"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_name" id="Call_parameters_items_i0_anyOf_i0_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_i0_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_type"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_type"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_type" id="Call_parameters_items_i0_anyOf_i0_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Call_parameters_items_i0_anyOf_i0_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_KEY_PAIR"</li></ul> </div><span class="const-value" id="Call_parameters_items_i0_anyOf_i0_type_const">Specific value: <code>"SSH_KEY_PAIR"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_attributes"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_attributes"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i0_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_attributes" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_attributes" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_attributes" id="Call_parameters_items_i0_anyOf_i0_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>At least one of the two keys must be provided on creation.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_attributes_private_key"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_attributes_private_key"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i0_attributes_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_attributes_private_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_private_key')" type="button"><span class="property-name">private_key</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_attributes_private_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_attributes_private_key" id="Call_parameters_items_i0_anyOf_i0_attributes_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i0" id="Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i1" id="Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_private_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_attributes_public_key"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_attributes_public_key"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i0_attributes_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_attributes_public_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_public_key')" type="button"><span class="property-name">public_key</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_attributes_public_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_attributes_public_key" id="Call_parameters_items_i0_anyOf_i0_attributes_public_key"> <div class="card-body pl-5"> <h4>Public Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Can be omitted and automatically derived from the private key.</p> </span><div class="any-of-value" id="Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i0" id="Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i1" id="Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_anyOf_i0_attributes_public_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_anyOf_i1" role="tabpanel"> <h4>KeychainCredentialCreateSSHCredentialsEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_name"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_name"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_name" id="Call_parameters_items_i0_anyOf_i1_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_i1_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_type"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_type"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_type" id="Call_parameters_items_i0_anyOf_i1_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Call_parameters_items_i0_anyOf_i1_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_CREDENTIALS"</li></ul> </div><span class="const-value" id="Call_parameters_items_i0_anyOf_i1_type_const">Specific value: <code>"SSH_CREDENTIALS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes" id="Call_parameters_items_i0_anyOf_i1_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_host"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_host"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_host" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_host')" type="button"><span class="property-name">host</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_host" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_host" id="Call_parameters_items_i0_anyOf_i1_attributes_host"> <div class="card-body pl-5"> <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_port"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_port"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_port" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_port" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_port" id="Call_parameters_items_i0_anyOf_i1_attributes_port"> <div class="card-body pl-5"> <h4>Port</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 22</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_username"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_username"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_username" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_username')" type="button"><span class="property-name">username</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_username" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_username" id="Call_parameters_items_i0_anyOf_i1_attributes_username"> <div class="card-body pl-5"> <h4>Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_private_key"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_private_key"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_private_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_private_key')" type="button"><span class="property-name">private_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_private_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_private_key" id="Call_parameters_items_i0_anyOf_i1_attributes_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Keychain Credential ID.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_remote_host_key"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_remote_host_key"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_remote_host_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_remote_host_key')" type="button"><span class="property-name">remote_host_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_remote_host_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_remote_host_key" id="Call_parameters_items_i0_anyOf_i1_attributes_remote_host_key"> <div class="card-body pl-5"> <h4>Remote Host Key</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Can be discovered with keychaincredential.remote<em>ssh</em>host<em>key</em>scan.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_attributes_connect_timeout"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_attributes_connect_timeout"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i0_anyOf_i1_attributes_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_attributes_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_attributes_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_attributes_connect_timeout" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_attributes_connect_timeout" id="Call_parameters_items_i0_anyOf_i1_attributes_connect_timeout"> <div class="card-body pl-5"> <h4>Connect Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 10</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><br/> <div class="any-of-value" id="Return_value_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0" id="Return_value_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0')" role="tab">SSHKeyPairEntry</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i1" id="Return_value_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1')" role="tab">SSHCredentialsEntry</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0" role="tabpanel"> <h4>SSHKeyPairEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i0_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_id" id="Return_value_anyOf_i0_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_name" id="Return_value_anyOf_i0_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i0_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_type"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_type"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_type" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_type" id="Return_value_anyOf_i0_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_anyOf_i0_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_KEY_PAIR"</li></ul> </div><span class="const-value" id="Return_value_anyOf_i0_type_const">Specific value: <code>"SSH_KEY_PAIR"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_attributes"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_attributes"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_attributes" id="Return_value_anyOf_i0_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>At least one of the two keys must be provided on creation.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i0_attributes_private_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_attributes_private_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_attributes_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_attributes_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_attributes_private_key')" type="button"><span class="property-name">private_key</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_attributes_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_attributes_private_key" id="Return_value_anyOf_i0_attributes_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Return_value_anyOf_i0_attributes_private_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_attributes_private_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_attributes_private_key_anyOf_i0" id="Return_value_anyOf_i0_attributes_private_key_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_attributes_private_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_attributes_private_key_anyOf_i1" id="Return_value_anyOf_i0_attributes_private_key_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_attributes_private_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0_attributes_private_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_attributes_private_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_attributes_public_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_attributes_public_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_attributes_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_attributes_public_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_attributes_public_key')" type="button"><span class="property-name">public_key</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_attributes_public_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_attributes_public_key" id="Return_value_anyOf_i0_attributes_public_key"> <div class="card-body pl-5"> <h4>Public Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Can be omitted and automatically derived from the private key.</p> </span><div class="any-of-value" id="Return_value_anyOf_i0_attributes_public_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_attributes_public_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_attributes_public_key_anyOf_i0" id="Return_value_anyOf_i0_attributes_public_key_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_attributes_public_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_attributes_public_key_anyOf_i1" id="Return_value_anyOf_i0_attributes_public_key_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_attributes_public_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0_attributes_public_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_attributes_public_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1" role="tabpanel"> <h4>SSHCredentialsEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i1_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_id" id="Return_value_anyOf_i1_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_name" id="Return_value_anyOf_i1_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i1_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_type"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_type"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_type" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_type" id="Return_value_anyOf_i1_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_anyOf_i1_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_CREDENTIALS"</li></ul> </div><span class="const-value" id="Return_value_anyOf_i1_type_const">Specific value: <code>"SSH_CREDENTIALS"</code></span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes" id="Return_value_anyOf_i1_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_host"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_host"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_host" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_host')" type="button"><span class="property-name">host</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_host" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_host" id="Return_value_anyOf_i1_attributes_host"> <div class="card-body pl-5"> <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_port"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_port"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_port" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_port" id="Return_value_anyOf_i1_attributes_port"> <div class="card-body pl-5"> <h4>Port</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 22</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_username"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_username"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_username" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_username')" type="button"><span class="property-name">username</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_username" id="Return_value_anyOf_i1_attributes_username"> <div class="card-body pl-5"> <h4>Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_private_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_private_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_private_key')" type="button"><span class="property-name">private_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_private_key" id="Return_value_anyOf_i1_attributes_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Keychain Credential ID.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_remote_host_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_remote_host_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_remote_host_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_remote_host_key')" type="button"><span class="property-name">remote_host_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_remote_host_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_remote_host_key" id="Return_value_anyOf_i1_attributes_remote_host_key"> <div class="card-body pl-5"> <h4>Remote Host Key</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Can be discovered with keychaincredential.remote<em>ssh</em>host<em>key</em>scan.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes_connect_timeout"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes_connect_timeout"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes_connect_timeout" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes_connect_timeout" id="Return_value_anyOf_i1_attributes_connect_timeout"> <div class="card-body pl-5"> <h4>Connect Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 10</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div><br><br>

*Required roles:* KEYCHAIN_CREDENTIAL_WRITE