Status of background pin requests can be inspected with the 'ls' command:
$ ipfs pin remote ls --service=mysrv --cid=bafkqaaa --status=queued,pinning,pinned,failed
`,
},
},
Arguments:[]cmds.Argument{
Arguments:[]cmds.Argument{
cmds.StringArg("ipfs-path",true,false,"Path to object(s) to be pinned."),
cmds.StringArg("ipfs-path",true,false,"Path to object(s) to be pinned."),
},
},
Options:[]cmds.Option{
Options:[]cmds.Option{
cmds.StringOption(pinNameOptionName,"An optional name for the pin."),
pinServiceNameOption,
pinServiceNameOption,
cmds.StringOption(pinNameOptionName,"An optional name for the pin."),
cmds.BoolOption(pinBackgroundOptionName,"Add to the queue on the remote service and return immediately (does not wait for pinned status).").WithDefault(false),
cmds.BoolOption(pinBackgroundOptionName,"Add to the queue on the remote service and return immediately (does not wait for pinned status).").WithDefault(false),
},
},
Type:RemotePinOutput{},
Type:RemotePinOutput{},
...
@@ -218,15 +240,18 @@ Returns a list of objects that are pinned to a remote pinning service.
...
@@ -218,15 +240,18 @@ Returns a list of objects that are pinned to a remote pinning service.
`,
`,
LongDescription:`
LongDescription:`
Returns a list of objects that are pinned to a remote pinning service.
Returns a list of objects that are pinned to a remote pinning service.
NOTE: By default, it will only show matching objects in 'pinned' state.
Pass '--status=queued,pinning,pinned,failed' to list pins in all states.
`,
`,
},
},
Arguments:[]cmds.Argument{},
Arguments:[]cmds.Argument{},
Options:[]cmds.Option{
Options:[]cmds.Option{
cmds.StringOption(pinNameOptionName,"Return pins objects with names that contain provided value (case-sensitive, exact match)."),
cmds.DelimitedStringsOption(",",pinCIDsOptionName,"Return only pin objects for the specified CID(s); optional, comma separated."),
cmds.DelimitedStringsOption(",",pinStatusOptionName,"Return only pin objects with the specified statuses (queued,pinning,pinned,failed)").WithDefault([]string{"pinned"}),
pinServiceNameOption,
pinServiceNameOption,
cmds.StringOption(pinNameOptionName,"Return pins with names that contain the value provided (case-sensitive, exact match)."),
cmds.DelimitedStringsOption(",",pinCIDsOptionName,"Return pins for the specified CIDs (comma-separated)."),
cmds.DelimitedStringsOption(",",pinStatusOptionName,"Return pins with the specified statuses (queued,pinning,pinned,failed).").WithDefault([]string{"pinned"}),
cmds.StringOption(pinNameOptionName,"Remove pin objects with names that contain provided value (case-sensitive, exact match)."),
cmds.StringOption(pinNameOptionName,"Remove pins with names that contain provided value (case-sensitive, exact match)."),
cmds.DelimitedStringsOption(",",pinCIDsOptionName,"Remove only pin objects for the specified CID(s)."),
cmds.DelimitedStringsOption(",",pinCIDsOptionName,"Remove pins for the specified CIDs."),
cmds.DelimitedStringsOption(",",pinStatusOptionName,"Remove only pin objects with the specified statuses (queued,pinning,pinned,failed).").WithDefault([]string{"pinned"}),
cmds.DelimitedStringsOption(",",pinStatusOptionName,"Remove pins with the specified statuses (queued,pinning,pinned,failed).").WithDefault([]string{"pinned"}),
cmds.BoolOption(pinForceOptionName,"Remove multiple pins without confirmation.").WithDefault(false),
cmds.BoolOption(pinForceOptionName,"Allow removal of multiple pins matching the query without additional confirmation.").WithDefault(false),